Skip to content
This repository has been archived by the owner on Jul 30, 2019. It is now read-only.

Update/add source header comments (continued) #1226

Merged
merged 16 commits into from
Feb 22, 2018

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Feb 19, 2018

Continuing to work through issue #1201

This commit adds new source header comments for the following files:

  • root
  • Semantics
  • Interactive elements
  • Rendering
  • Web Application APIs (revised)

This commit touches other previously edited source files to continue to normalize the way we format these source headers.

  • browsers
  • dom
  • iana
  • Infrastructure
  • introduction
  • obsolete
  • common idioms
  • document metadata
  • edits
  • embedded content
  • sections
  • tabular data

- some privacy considerations
- an introduction to HTML itself, how to write it, etc.
- non-normative conformance requirements for content
- links to some other specs: charmod, unicode security, and some accessibility specs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unicode - is a proper noun so should start with a capital letter. I think.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated


Interactive Elements

This source produces section 4.7: Embedded Content
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this header is incorrect. Appears to be a duplicate of the one in semantics-embedded-content.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!


It covers

- media elements:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, I think it covers details/summary, dialog, and commands

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow. sorry about that. I don't know what happened there.

Just pushed a fix!

@scottaohara
Copy link
Member Author

PR edit:
New commits completes the checklist and fixes #1201.
Includes:

  • forms
  • syntax
  • scripting
  • grouping content
  • text-level semantics

Copy link
Collaborator

@chaals chaals left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Many thanks

@chaals chaals merged commit 43ca139 into master Feb 22, 2018
@scottaohara scottaohara deleted the so_source_file_header_comments branch February 22, 2018 16:39
plehegar pushed a commit that referenced this pull request Feb 22, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants