Fix minor documentation and comment typos #2061
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
sandwwraith
requested changes
Oct 13, 2022
| @@ -268,7 +268,7 @@ internal open class StreamingJsonDecoder( | |||
|
|
|||
| override fun decodeBoolean(): Boolean { | |||
| /* | |||
| * We prohibit non true/false boolean literals at all as it is considered way too error-prone, | |||
| * We prohibit non-true/false boolean literals at all as it is considered way too error-prone, | |||
There was a problem hiding this comment.
Here it would actually change the meaning. The original comment "non true/false" means "any literal that is not equal to 'true' or 'false'", while changed versions read as "We prohibit non-true OR false boolean literals".
You can rephrase this to "We prohibit any boolean literal that is not strictly 'true' or 'false'"
There was a problem hiding this comment.
good spot, thanks. Your rephrasing is much more clear.
sandwwraith
approved these changes
Oct 13, 2022
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.
Very minor points. I'm mostly committing so my IDE will show fewer warnings.