Sienna-Platform / Sienna-Platform/PowerOperationsModels.jl
[RFC] Simplify metadata
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Julia
- Stars
- 2
- Forks
- 1
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 26
Description
If the mapping from like VariableKey to String was reversible, then we wouldn't need to store this metadata object (which allows us to do lookups like read_variable(outputs, VariableAsString)).
This would be a breaking change that probably affects everyone though.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the VariableKey-to-String mapping, the metadata object, and callers of read_variable(outputs, VariableAsString). Review how VariableKey and VariableAsString are represented and identify the breaking API impact; done means a reversible mapping and an agreed replacement for metadata-backed lookups.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100