style guide: no requirements in "Examples" sections #4382
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
This was referenced Feb 25, 2025
lornajane
reviewed
Feb 27, 2025
style-guide.md
Outdated
| @@ -21,6 +21,7 @@ The following additional rules should be followed but currently are not enforced | |||
| 9. Use [Oxford commas](https://en.wikipedia.org/wiki/Serial_comma), avoid [Shatner commas](https://www.latimes.com/archives/blogs/jacket-copy/story/2011-06-30/goodbye-oxford-comma-hello-shatner-comma). | |||
| 10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated. | |||
| 11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line. | |||
| 12. Do not add requirements in "Examples" sections, and avoid [RFC2119 key words (MUST, MAY, ...)](https://datatracker.ietf.org/doc/html/rfc2119) in these sections. | |||
There was a problem hiding this comment.
What are requirements here? Is that the same thing as using a MUST/MAY keyword. Would it be accurate to say that this sort of content needs to be in a different section?
|
I tried to follow the thread of the other pull request, some comments, and what caused this change, but I'm not really clear, sorry. Could you add a note to the pull request description about what problem this solves or what we need to do or not do? I think it would help to inform the reviewer (me!) |
@lornajane's suggestion
# for free
to join this conversation on GitHub.
Already have an account?
# 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 #4339 (comment).
PR #4339 added text to an "Examples" section that used requirements language with "MUST" and "MAY". In this case the text was just copied verbatim from "non-example" sections of the spec, and no new requirements were added.
Better style is to
Tick one of the following options: