🌱 Fix minor issues in the API help strings #1936
Merged
Conversation
This file contains 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
|
/cc @zaneb |
metal3-io-bot
added
the
size/M
zaneb
reviewed
Sep 5, 2024
| @@ -833,7 +832,7 @@ type BareMetalHostStatus struct { | |||
| // The last error message reported by the provisioning subsystem. | |||
| ErrorMessage string `json:"errorMessage"` | |||
|
|
|||
| // Whether or not the host is currently powered on. This field may get | |||
| // The currently detected power state of the host. This field may get | |||
| // briefly out of sync with the actual state of the hardware while | |||
| // provisioning processes are running. | |||
There was a problem hiding this comment.
I meant we could say 'currently detected' instead of all the stuff about being briefly out of sync.
I feel like it goes without saying that we are in a distributed system and detection is not instananeous.
There was a problem hiding this comment.
I'd rather keep the second part here because it's a common source of confusion.
|
/lgtm |
metal3-io-bot
added
lgtm
Follow-up to commit 9a30c0d. Signed-off-by: Dmitry Tantsur <[email protected]>
metal3-io-bot
removed
lgtm
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: elfosardo The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
metal3-io-bot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Follow-up to commit 9a30c0d.
Signed-off-by: Dmitry Tantsur [email protected]