Use uppercase for RFC 2119 terms - #38
Closed
jzern wants to merge 2 commits into
Closed
Conversation
This removes the default conformance section which says: * [...] as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.* And adds a Terminology section at the beginning of the text to make the conventions more prominent. Fixes: AOMediaCodec#26
jzern
commented
Jul 22, 2026
|
|
||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[!RFC2119]] [[!RFC8174]] when, and only when, they appear in all capitals, as shown here. | ||
|
|
||
| All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. |
Author
There was a problem hiding this comment.
This text comes from the default conformance section: https://aomediacodec.github.io/av1-isobmff/#conformance
|
|
||
| All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. | ||
|
|
||
| Examples in this specification are introduced with the words "for example" or are set apart from the normative text with <code>class="example"</code>, like this: |
Author
There was a problem hiding this comment.
Note "for example" is used at line 393, where we have a SHOULD. Do we want to relax this or make the SHOULD lowercase?
Author
There was a problem hiding this comment.
Me too given how examples described. I just forgot to lowercase that one before uploading so I wanted to call it out.
|
|
||
| <div class="example" id="example-example"><a class="self-link" href="#example-example"></a>This is an example of an informative example.</div> | ||
|
|
||
| Informative notes begin with the word "Note" and are set apart from the normative text with <code>class="note"</code>, like this: |
Author
There was a problem hiding this comment.
The note at line 317 has a 'may', which I made lowercase.
| Terminology {#terminology} | ||
| ========================== | ||
|
|
||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[!RFC2119]] [[!RFC8174]] when, and only when, they appear in all capitals, as shown here. |
Author
There was a problem hiding this comment.
"required" was not used in a way that would make it normative.
jzern
marked this pull request as ready for review
July 22, 2026 21:03
jzern
commented
Jul 22, 2026
| } | ||
| </pre> | ||
|
|
||
| Terminology {#terminology} |
Author
There was a problem hiding this comment.
I've also seen something like 'Notation & Conventions' to describe this section.
Author
|
@podborski looks like there are some bot failures: |
y-guyon
approved these changes
Jul 23, 2026
|
|
||
| All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. | ||
|
|
||
| Examples in this specification are introduced with the words "for example" or are set apart from the normative text with <code>class="example"</code>, like this: |
Member
|
@jzern no forks please. you should be able to work in this repo directly. please open a PR from a branch in this repo |
Author
|
Superseded by #41. |
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.
This removes the default conformance section which says:
do not appear in all uppercase letters in this specification.*
And adds a Terminology section at the beginning of the text to make the
conventions more prominent.
Fixes: #26