Rename ElectricalComponentError to ElectricalComponentDiagnostic
#309
Conversation
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
github-actions
bot
added
part:docs
llucax
previously approved these changes
Apr 15, 2025
Contributor
llucax
left a comment
llucax
left a comment
There was a problem hiding this comment.
What copilot said, otherwise LGTM.
This commit improves the naming of the `ElectricalComponentError` message to `ElectricalComponentDiagnostic`, to better reflect its purpose of representing both warnings and errors in microgrid electrical components. Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
rename_elec_component_err_enum
branch
from
de09b6f to
573bf0e
Compare
llucax
approved these changes
Apr 15, 2025
Contributor
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:485
- Ensure that the renaming from ElectricalComponentError to ElectricalComponentDiagnostic is consistent throughout the file, including all associated enums and documentation comments.
message ElectricalComponentDiagnostic {
RELEASE_NOTES.md:17
- [nitpick] Verify that the release notes reference the correct original identifier; if the proto file was renamed from ElectricalComponentErrorCode, update this line to match that naming for clarity.
The enum `ComponentErrorCode` has now been renamed to `ElectricalComponentDiagnosticCode` to better reflect its shared usage with warnings and errors.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit improves the naming of the
ElectricalComponentErrormessage toElectricalComponentDiagnostic, to better reflect its purpose of representing both warnings and errors in microgrid electrical components.Followed up from this comment: #308 (comment)