[std] Replace 'OK:' in code comments with 'OK,'#5080
Merged
tkoeppe merged 1 commit intocplusplus:mainfrom Nov 23, 2021
Merged
Conversation
In contrast to errors, which use a colon, an OK comment is not followed by any unique reason why the code is well-formed, but by a subjective highlighting of a fact.
JohelEGP
reviewed
Oct 27, 2021
Comment on lines
+1757
to
1758
| auto x = 5, *y = &x; // OK, \keyword{auto} is \tcode{int} | ||
| auto a = 5, b = { 1, 2 }; // error: different types for \keyword{auto} |
Contributor
There was a problem hiding this comment.
Examples shouldn't use \keyword, right?
Member
Author
There was a problem hiding this comment.
Yeah, probably not. Hm. Maybe I can \let\keyword\tcode inside a codeblock to avoid the index entry, yet permit consistent use of \keyword everywhere. The latter helps to ensure all keywords are actually annotated as such, using automated checking machinery.
Member
Author
There was a problem hiding this comment.
Anyway, this is unrelated to the present pull request.
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
3 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.
In contrast to errors, which use a colon, an OK comment
is not followed by any unique reason why the code is
well-formed, but by a subjective highlighting of a fact.