Update stat producerId documentation (#64)

## Description Align the `producerId` description with the `Data` one, since they are the same. ## Changes Made Align the `producerId` description with the `Data` one, since they are the same. ## Related Issues N/A ## Checklist - [ ] I have used a PR title that is descriptive enough for a release note. - [ ] I have tested these changes locally. - [ ] I have added appropriate tests or updated existing tests. - [ ] I have tested these changes on a dedicated VM or a customer VM [name of the VM] - [x] I have added appropriate documentation or updated existing documentation. --------- Co-authored-by: Bot <[email protected]> Co-authored-by: AntoineChalons <[email protected]>
zaphiro-technologies · Jun 24, 2024 · e9954eb · e9954eb
1 parent 4d10895
commit e9954eb
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,6 +1,10 @@
 # ProtoBuf Release Notes
 
-## 0.0.7-dev - 2024-06-19
+## 0.0.7-dev - 2024-06-24
+
+### Documentation
+
+- Update stat producerId documentation (PR #64 by @hiimjako)
 
 ### Dependencies
 

diff --git a/docs/stat.proto.md b/docs/stat.proto.md
@@ -30,7 +30,7 @@ direction LR
 %% A Stat of PMU data, check IEEE C37.118 standard for more details.
 %% Headers used in rabbitMQ:
 %% * `id` (string): id of the `Stat` message.
-%% * `producerId` (string): the id of the PMU linked to the Stat.
+%% * `producerId` (string): the id of the producer (e.g. a PMU) linked to the dataset.
 %% * `timestampId` (int64): related measurement Unix msec timestamp (if any)
 %% 
 
@@ -56,7 +56,7 @@ class Stat {
 A Stat of PMU data, check IEEE C37.118 standard for more details.
 Headers used in rabbitMQ:
 * `id` (string): id of the `Stat` message.
-* `producerId` (string): the id of the PMU linked to the Stat.
+* `producerId` (string): the id of the producer (e.g. a PMU) linked to the dataset.
 * `timestampId` (int64): related measurement Unix msec timestamp (if any)
 
 

diff --git a/zaphiro/c37118/v1/stat.proto b/zaphiro/c37118/v1/stat.proto
@@ -10,7 +10,7 @@ option go_package = "./c37118/v1";
 /* A Stat of PMU data, check IEEE C37.118 standard for more details.
 Headers used in rabbitMQ:
 * `id` (string): id of the `Stat` message.
-* `producerId` (string): the id of the PMU linked to the Stat.
+* `producerId` (string): the id of the producer (e.g. a PMU) linked to the dataset.
 * `timestampId` (int64): related measurement Unix msec timestamp (if any)
 */