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

Typos, formatting, and clarity suggestions #28

Closed
pes10k opened this issue Jan 6, 2022 · 2 comments · Fixed by #33
Closed

Typos, formatting, and clarity suggestions #28

pes10k opened this issue Jan 6, 2022 · 2 comments · Fixed by #33
Assignees

Comments

@pes10k
Copy link

pes10k commented Jan 6, 2022

This issue is part of the PING privacy review w3cping/privacy-request#65

While reviewing the spec for the privacy review, I found a couple of non-substantive issues in the text, issues that aren't related to privacy concerns, but would help the reader in following along.

  • Typo: "an (hypothetical)" -> "a (hypothetical)"
  • Nit: caps consistancy. Should defined terms should either be title case (e.g., "IMSC Document Instance") or sentence case (e.g. "intermediate synchronic documents"), but switching between the two is confusing (since its not clear when its a reference to a document section or a term of art)
  • Links: There are many terms used in the document that will not be familiar most readers. However, instead of linking to definitions for these terms, though, links are just given for the document containing the definitions. So, for example, currently the document has terms like "intermediate synchronic documents" link to same-document text saying "Intermediate Synchronic Document. See [ttml2].". With that "ttml2" link taking the reader to the top of the TTML2 spec. It would be more helpful to have "intermediate synchronic documents" link directly to the part of the TTML2 spec that defines "intermediate synchronic documents" (i.e., https://www.w3.org/TR/2018/REC-ttml2-20181108/#semantics-region-layout-step-1)
@palemieux
Copy link
Contributor

@pes10k See #33

Re: title case, I tried to make the capitalization of defined terms consistent with their definition. The current trend is to avoid capitalization, lest we end-up with uppercase everywhere, and so some of the more recent terms, including those defined in this document are lowercase.

@pes10k
Copy link
Author

pes10k commented Jan 24, 2022

I see, understood then. If thats the convention then, then I think #33 addresses the concern. Thanks!

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

Successfully merging a pull request may close this issue.

2 participants