Add energy metric information#235
Add energy metric information#235flora-hofmann-frequenz merged 1 commit intofrequenz-floss:v0.x.xfrom
Conversation
| // | ||
| // AC energy metrics information: | ||
| // | ||
| // * This energy metric is reported directly from the component, and not a | ||
| // result of aggregations in our systems. If a component does not have this | ||
| // metric, this field cannot be populated. | ||
| // | ||
| // * Components that provide energy metrics reset this metric from time to | ||
| // time. This behaviour is specific to each component model. E.g., some | ||
| // components reset it on UTC 00:00:00. | ||
| // | ||
| // * This energy metric does not specify the timestamp since when the energy | ||
| // was being accumulated, and therefore can be inconsistent. |
There was a problem hiding this comment.
LGTM in general. Should we make it more visible by making it a note?
That way it looks more like a notice, and not general documentation about this enum.
There was a problem hiding this comment.
A bunch of CI test are failing now that I was trying to mark it down as a note. Should I change it back?
84701da to
6d4b0dd
Compare
| > [!NOTE] | ||
| > AC energy metrics information: | ||
| > * This energy metric is reported directly from the component, and not a | ||
| > result of aggregations in our systems. If a component does not have this | ||
| > metric, this field cannot be populated. | ||
| > * Components that provide energy metrics reset this metric from time to | ||
| > time. This behaviour is specific to each component model. E.g., some | ||
| > components reset it on UTC 00:00:00. | ||
| > * This energy metric does not specify the timestamp since when the energy | ||
| > was being accumulated, and therefore can be inconsistent. |
There was a problem hiding this comment.
The comment looks incorrect .. these should start wist //, no?
Maybe better to use the MkDocs format here. Here is an example:
// !!! note
// This is a note.
// This is the second line.
There was a problem hiding this comment.
Ah sorry, I thought it was suppose to look like in the markup docs (but maybe I looked at the wrong one).
There was a problem hiding this comment.
MkDocs now supports also GitHub format toob(via a plugin, not sure if this repo is up to date enough to use it though). in any case, using GitHub format probably makes sense only in markdown files that will actually be interpreted by GitHub, which is not the case for .proto files, so I agree it might be better to use MkDocs format instead here.
There was a problem hiding this comment.
Sounds good :-)
Signed-off-by: Flora <flora.hofmann@frequenz.com>
6d4b0dd to
2ec866e
Compare
This is the same additional info as in the common-client.