Rename metric_sample.proto to metrics.proto
#338
Merged
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
This PR renames the proto file from metric_sample.proto to metrics.proto to better reflect the file content and improve clarity across related imports.
- Update import paths in sensors.proto and electrical_components.proto
- Introduce a minor typo in a comment within metrics.proto
- Update RELEASE_NOTES.md to document the file rename
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Updated import path to reflect the new proto filename |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Updated import path to use new metrics.proto |
| proto/frequenz/api/common/v1/metrics/metrics.proto | Typo in a comment line ("c//") that should be corrected |
| RELEASE_NOTES.md | Documented the file rename change |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/metrics/metrics.proto:25
- There appears to be an unintended character 'c' preceding the comment marker. Remove the 'c' so that the comment starts with '//' to improve clarity.
c// The message allows for the reporting of statistical summaries — minimum,
This change renames the `metric_sample.proto` file to `metrics.proto` to better reflect its content. The file contains multiple metric-related messages, including `SimpleMetricValue` and `MetricSample`, which are used to represent metric values and samples, respectively. The new name `metrics.proto` is more descriptive and aligns with the purpose of the file. Signed-off-by: Tiyash Basu <[email protected]> # Conflicts: # RELEASE_NOTES.md
tiyash-basu-frequenz
force-pushed
the
metric_file_rename
branch
from
60aada0 to
06b6f0c
Compare
github-actions
bot
added
the
part:tests
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 change renames the
metric_sample.protofile tometrics.prototo better reflect its content. The file contains multiple metric-related messages, includingSimpleMetricValueandMetricSample, which are used to represent metric values and samples, respectively. The new namemetrics.protois more descriptive and aligns with the purpose of the file.