This repository has been archived by the owner on Jul 30, 2019. It is now read-only.
1224 editorial updates for section & article #1324
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
in an attempt to better convey the purposes of each element, the prose of `article` and `section` have been updated. Regarding `article` two new paragraphs have been added to indicate nested elements can be used within an `article` to promote logical semantics for the article’s prose. The `section` element is called out specifically to indicate how sections of an `article` may be explicitly set via this element. Regarding the `section` element, two of the existing notes have been updated to further callout the differences between a `section` and `article`’s definitions.
|
I didn't merge because I'd like a second review on this. Semantics is hard, because measuring it against e.g. browser implementation data is very hard and not very reliable... |
prlbr
reviewed
Apr 2, 2018
sections/semantics-sections.include
Outdated
| entry on a site could consist of summaries of other blog entries in <{article}> elements nested | ||
| within the <{article}> element for the blog entry. | ||
| Additionally, an article may consist of various subsections that, together, form the complete | ||
| composition. These subsections may be implicitly implied by the use of appropriately ranked |
There was a problem hiding this comment.
“implicitly implied” is tautological.
LJWatson
reviewed
Apr 2, 2018
sections/semantics-sections.include
Outdated
| <{section}> element when the content is complete, or self-contained, composition. | ||
| Unlike an <{article}>, a <{section}> may not be fully understandable if taken out of context | ||
| of its originating document or application. Authors are encouraged to use the <{article}> | ||
| element instead of the <{section}> element when the content is complete, or self-contained, |
There was a problem hiding this comment.
Add "a" into "the content is *a complete, or self-contained..."
There was a problem hiding this comment.
Thanks @LJWatson! updated and will merge after checks finish. :)
|
LGTM. @scottaohara, feel free to merge once you've fixed the minor grammatical nit I noted :) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1224, in that these suggested updates to the prose for
articleandsectionare meant to further clarify the existing purposes for each element.articles remain elements that contain a full composition, andsections remain elements that demarcate sub-sections of anarticle, document or application.Example 7 was updated to include a brief example of when an
articlewithin asectionelement may be appropriate.Some minor typos and source formatting are includes in these updates.