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

The key words for conformance are misused. (UPPERCASES <-> lowercases) #840

Closed
sunghee-hwang opened this issue Jul 5, 2024 · 0 comments
Closed
Assignees
Labels
editorial Improvements or additions to documentation

Comments

@sunghee-hwang
Copy link
Collaborator

In the spec, the keywords are used somewhere in Notes and Convention.
And, there are still lower cases in the normative sections.

We should use "UPPERCASES" in the following normative sections:

  • Section 2 Immersive Audio Model
  • Section 3 Open Bitstream Unit (OBU) Syntax and Semantics
  • Section 4 Profiles
  • Section 5 Standalone IAMF Representation
  • Section 6 ISO-BMFF IAMF Encapsulation
  • Section 7 IAMF Processing

We should use "lowercases" in the other informative sections (Sections 1, 8, 9, and 10), notes, and examples.
Also, we don't need to use the keywords for conformance for the Convention section.

Here are examples of misusing in the spec.

  • Section 2: Many "may" are used but "MAY" is used in a Note.
  • Section 3: "MAY" is used in a Note.
  • Section 6: "optional" is used.
  • Section 8: "SHALL" is used.
@sunghee-hwang sunghee-hwang added the editorial Improvements or additions to documentation label Jul 5, 2024
@sunghee-hwang sunghee-hwang self-assigned this Jul 5, 2024
sunghee-hwang added a commit that referenced this issue Jul 14, 2024
Fix #840, align of the keywords for conformance (UPPERCASE <-> lowerc…
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant