Add Snapshot prefix to sensor and electrical component states
#341
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a Snapshot suffix to state messages for sensors and electrical components to clarify that they represent sampled snapshots of state.
- Renames
SensorStatetoSensorStateSnapshotinsensors.proto - Renames
ElectricalComponentStatetoElectricalComponentStateSnapshotinelectrical_components.proto - Updates
RELEASE_NOTES.mdto document both renames
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Renamed message and should update its doc comment to reflect “Snapshot” terminology |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Renamed message and should update its doc comment to reflect “Snapshot” terminology |
| RELEASE_NOTES.md | Added entries for the two message renames |
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:170
- [nitpick] Update this comment to clarify it represents a snapshot, e.g.,
// Representation of a sensor state snapshot and errors.
// Representation of a sensor state and errors.
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:476
- [nitpick] Update this comment to clarify it represents a snapshot, e.g.,
// Representation of a component state snapshot, warnings, and errors.
// Representation of a component state, warnings, and errors.
The state message in this case is a snapshot of the state of the electrical component's composite sttae at a given time. The name `ElectricalComponentStateSnapshot` is more descriptive and accurately reflects the purpose of the message. Signed-off-by: Tiyash Basu <[email protected]> # Conflicts: # RELEASE_NOTES.md
The state message in this case is a snapshot of the sensor's composite state at a given time. The name `SensorStateSnapshot` is more descriptive and accurately reflects the purpose of the message. Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
326_snapshot
branch
from
f66ed39 to
5c917b4
Compare
| message SensorState { | ||
| message SensorStateSnapshot { | ||
| // The time at which the state was sampled. | ||
| google.protobuf.Timestamp sampled_at = 1; |
Contributor
There was a problem hiding this comment.
The issue conversation wants origin_time/snapshot_time here (for SensorStateSnapshot).
| message ElectricalComponentState { | ||
| message ElectricalComponentStateSnapshot { | ||
| // The time at which the state was sampled. | ||
| google.protobuf.Timestamp sampled_at = 1; |
Contributor
There was a problem hiding this comment.
The issue conversation wants origin_time/snapshot_time here (for ElectricalComponentStateSnapshot).
Contributor
There was a problem hiding this comment.
Exactly, I just also spotted that and reopened the issue.
Contributor
|
Also nitpick, these are suffixes, not prefixes 😅 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
closes #326