Skip to content

Rename DataUpdateCurrentsPerPhase to DataUpdateCurrentPerPhase (BC)#183

Open
andig wants to merge 2 commits into
enbility:devfrom
andig:patch-3
Open

Rename DataUpdateCurrentsPerPhase to DataUpdateCurrentPerPhase (BC)#183
andig wants to merge 2 commits into
enbility:devfrom
andig:patch-3

Conversation

@andig

@andig andig commented Oct 13, 2025

Copy link
Copy Markdown
Contributor

Fix #182

@andig andig changed the title Rename DataUpdateCurrentsPerPhase to DataUpdateCurrentPerPhase Rename DataUpdateCurrentsPerPhase to DataUpdateCurrentPerPhase (BC) Oct 13, 2025
@andig

andig commented Jun 10, 2026

Copy link
Copy Markdown
Contributor Author

@sthelen-enqs this is a breaking chore fix that would help improve naming consistency

@uhl

uhl commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

@andig Thanks for the contribution— you're right that CurrentPerPhase is the correct name and Currents is the outlier (the MPC interface method is already CurrentPerPhase).
I'd hold off on merging this as a hard rename though. DataUpdateCurrentsPerPhase is part of the public API and I can see at least a handful of downstream consumers on GitHub. A cosmetic rename that forces every one of them to touch their import sites on the next release feels like a poor tradeoff for the ergonomic win — especially since the CONTRIBUTING guideline explicitly discourages purely cosmetic patches, and there's no changelog convention here to loudly signal the break.
What do you think?

@andig

andig commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

@uhl thank you for the comment. I agree this is a breaking change. However- with 0.x versions breaking changes are to be expected. The issue here is that it makes the library usage confusing and imho more than a cosmetic rename. PR (and commit) is already named BC to signal that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Minor inconsistency between MPC and MGCP event names

2 participants