doc/Invoke: Clearer "success indicator" wording for errors #840
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
A user was confused by the wording, > If the final returned object is an error, > it's assumed to be a success indicator. They reasonably expect that an error is an indicator of failure. Clarify the sentence to make it clear that the error indicates *whether* the operation was successful.
Codecov Report
@@ Coverage Diff @@
## master #840 +/- ##
=======================================
Coverage 98.42% 98.42%
=======================================
Files 30 30
Lines 1076 1076
=======================================
Hits 1059 1059
Misses 11 11
Partials 6 6
Continue to review full report at Codecov.
|
moisesvega
approved these changes
Feb 15, 2022
r-hang
approved these changes
Feb 15, 2022
josephinedotlee
pushed a commit
that referenced
this pull request
Feb 18, 2022
A user was confused by the wording, > If the final returned object is an error, > it's assumed to be a success indicator. They reasonably expect that an error is an indicator of failure. Clarify the sentence to make it clear that the error indicates *whether* the operation was successful.
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.
A user was confused by the wording,
They reasonably expect that an error is an indicator of failure.
Clarify the sentence to make it clear that the error indicates whether
the operation was successful.