Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generated "Conformance" section looks a bit weird #2942

Open
leo-barnes opened this issue Oct 24, 2024 · 1 comment
Open

Auto-generated "Conformance" section looks a bit weird #2942

leo-barnes opened this issue Oct 24, 2024 · 1 comment

Comments

@leo-barnes
Copy link

See this issue for reference: AOMediaCodec/av1-avif#282

The generated Conformance section looks like this:

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Why do we have the extra RFC2119 mentioned right at the end as an extra link? Why not simply make the first two mentions of RFC2119 regular spec links?

@wantehchang
Copy link

Another minor issue is the example of an informative note:

Note, this is an informative note.

It is more common to follow "Note" or "NOTE" with a semicolon (:) than a comma (,).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants