Sienna-Platform / Sienna-Platform/PowerOperationsModels.jl

`get_foo_multiplier` madness

Open
#10 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
2
Forks
1
Avg merge
1d 16h
Merged PRs (30d)
26

Description

We have a boatload of get_foo_multiplier methods. Do some cleanup on those. Main questions/goals:

  • Do these actually need the component instance, or is the type sufficient?
  • Is this really a power direction thing, in vs out or load vs generator? If 95% of the instances simply return 1.0 or -1.0, then that's a sign we should rethink the design.
  • Do we really need all the arguments in most cases? Are we over-constraining the multiple dispatch?
  • Naming clarity.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the get_foo_multiplier methods and their callers, then compare whether they use component instances, power direction, or their current arguments. Done means the multiplier API has a decided design, clearer names, and simplified dispatch where appropriate; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.