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

§6.2.3: Improving hyperlinks #695

Closed
podborski opened this issue Aug 3, 2023 · 2 comments · Fixed by #743
Closed

§6.2.3: Improving hyperlinks #695

podborski opened this issue Aug 3, 2023 · 2 comments · Fixed by #743
Labels
editorial Improvements or additions to documentation

Comments

@podborski
Copy link
Collaborator

Version Source Clause(s)
AOM Working Group Draft, 17 July 2023 Apple §6.2.3

Comment:

When I click hyperlinks in configOBUs semantics, for example the Codec Config OBU``, the hyperlink points to clause 2.3.2.1 while it would be much better (in my opinion) if it would point directly to clause 3.5 where that element is specified.

Also in clause 3.5 I feel like instead of just writing:

This section specifies the OBU payload of OBU_IA_Codec_Config.

it could provide a better description based on the text in clause 2.3.2.1. For example this could be written like:

The Codec Config OBU provides information on how to set up a decoder for a coded Audio Substream. This clause specifies the payload format of the Codec Config OBU.

Same comment applies to other elements.

@podborski podborski added the editorial Improvements or additions to documentation label Aug 3, 2023
@cconcolato
Copy link
Contributor

@tdaede
Copy link
Collaborator

tdaede commented Aug 28, 2023

@felicialim is working on a PR to fix these links.

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

Successfully merging a pull request may close this issue.

3 participants