EEBus: drop redundant Scenario middle word from constant names#29704
Merged
EEBus: drop redundant Scenario middle word from constant names#29704
Conversation
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- These renames change exported identifiers; if this package is consumed externally you may want to keep the old
*Scenario*constants as deprecated aliases for a release cycle to avoid breaking downstream users. - Since all of these values represent scenario IDs, consider defining a dedicated
type Scenario uint(or similar) and using it for the constants and relevant function signatures to improve type safety and self-documentation.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- These renames change exported identifiers; if this package is consumed externally you may want to keep the old `*Scenario*` constants as deprecated aliases for a release cycle to avoid breaking downstream users.
- Since all of these values represent scenario IDs, consider defining a dedicated `type Scenario uint` (or similar) and using it for the constants and relevant function signatures to improve type safety and self-documentation.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #29701. Constant names like
MGCPScenarioPowerandEVCEMScenarioPowerPerPhaserepeat the wordScenarioeven though every constant in this package is a scenario number. Drop the middle word so call sites read more naturally:eebus.MGCPScenarioPower→eebus.MGCPPowereebus.MPCScenarioCurrentPerPhase→eebus.MPCCurrentPerPhaseeebus.LPCScenarioLimit→eebus.LPCLimiteebus.EVCEMScenarioPowerPerPhase→eebus.EVCEMPowerPerPhaseThe use-case prefix (
MGCP,MPC,LPC,LPP,OPEV,OSCEV,EVCEM,EVSOC) keeps the namespace clear; the trailing word names the quantity.Scenarioadds nothing because the type and the comment already say so.No behavior change.
Test plan
go build ./charger/... ./meter/... ./server/eebus/...passesgo test ./charger/... ./meter/... ./server/eebus/...passesgofmt -lclean