Improve the Lifetime message documentation#259
Merged
llucax merged 1 commit intofrequenz-floss:v0.x.xfrom Sep 30, 2024
Merged
Conversation
Contributor
Author
|
Skipping release notes, I think they are not necessary for such a small documentation change. |
Comment on lines
+24
to
+25
| // If the `end_timestamp` is not set, the asset is considered to be in | ||
| // operation until the end of the system's operational history. |
Contributor
There was a problem hiding this comment.
The "end of history" part reads a bit odd, because history indicates past tense. I feel that phrase does not add anything here, and can be removed:
Suggested change
| // If the `end_timestamp` is not set, the asset is considered to be in | |
| // operation until the end of the system's operational history. | |
| // If the `end_timestamp` is not set, the asset is considered to be in | |
| // operation. |
The same comment applies to other instances where end-timestamp is being documented.
Contributor
Author
There was a problem hiding this comment.
What about "... is considered to be in operation indefinitely in the future"? I would like to make it explicit that it is in operation now but also at any time in the future.
Contributor
There was a problem hiding this comment.
Sounds good. Should then be "indefinitely into the future".
Make the specification of what `Lifetime` message is used for as clear and precise as possible. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
8c97ed1 to
cf667ca
Compare
Contributor
Author
|
Enabling auto-merge. |
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
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.
Make the specification of what
Lifetimemessage is used for as clear and precise as possible.Fixes #250.