Add the deletion and insertion roles (w3c#526) #916
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
mcking65
reviewed
Mar 21, 2019
index.html
Outdated
| <div class="role" id="deletion"> | ||
| <rdef>deletion</rdef> | ||
| <div class="role-description"> | ||
| <p>A deletion represents the previous removal of content, or a potential future removal of content. Deletion is helpful for marking differences with a previous version of content, as well as suggestions from co-authors for removal of content.</p> |
There was a problem hiding this comment.
Perhaps:
<p>A deletion element contains content that is marked as removed or content that is being suggested for removal. See related <rref>insertion</rref>.</p>
<p>Deletions, which are often styled as struck out, are typically used to either mark differences between two versions of content or to designate content suggested for removal in scenarios where multiple people are revising content.</p>
I suggest two paragraphs to be consistent with other roles where the definition is a single, short sentence or phrase followed by a second explanitory paragraph.
As a structural role, the definition language should clearly define the element as a container. This suggested revision attempts to do so in a way that is consistent with the style of other structural roles.
index.html
Outdated
| <div class="role" id="insertion"> | ||
| <rdef>insertion</rdef> | ||
| <div class="role-description"> | ||
| <p>An insertion represents the previous addition of content, or a potential future addition of content. Insertion is helpful for marking differences with a previous version of content, as well as suggestions from co-authors for addition of content.</p> |
There was a problem hiding this comment.
Suggest the following for the same reasons stated above in the insertion definition comment.
<p>An insertion element contains content that is marked as recently added or content that is being suggested for addition. See related <rref>deletion</rref>.</p>
<p>Insertions are typically used to either mark differences between two versions of content or to designate content suggested for addition in scenarios where multiple people are revising content.</p>
|
Matt, I basically used your text except:
|
jnurthen
approved these changes
Mar 21, 2019
melanierichards
approved these changes
Mar 28, 2019
joanmarie
pushed a commit
that referenced
this pull request
Oct 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Preview of insertion
Preview of deletion