Update introduction.adoc to use RFC 2119 terminology everywhere #693
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
Following RFC 2119 terminology to remove ambiguity
tkrop
reviewed
Dec 7, 2021
Comment on lines
-58
to
+65
| * existing APIs don't have to be changed, but we recommend it | ||
| * clients of existing APIs have to cope with these APIs based on | ||
| * it is RECOMMENDED that the existing APIs be changed | ||
| * clients of existing APIs MUST cope with these APIs based on | ||
| outdated rules | ||
| * new APIs have to respect the current guidelines | ||
| * new APIs MUST respect the current guidelines | ||
|
|
||
| Furthermore you should keep in mind that once an API becomes public | ||
| externally available, it has to be re-reviewed and changed according to | ||
| current guidelines - for sake of overall consistency. | ||
| externally available, it MUST be re-reviewed and changed according to | ||
| current guidelines - for the sake of overall consistency. |
There was a problem hiding this comment.
@sdousti Thank you for your contribution and sorry for the late reply.
As much as I like your rewording, the use of capital letter MUST and RECOMMENDED is currently not consistent with our usage in text - only in rule titles. If you change it to lower case bold, we would merge it for. Else we would need to agree on a new style before we can merge your suggestions (see also comment on #660).
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.
Following RFC 2119 terminology everywhere helps in removing any ambiguity.