docs: small fixes and improvements #7128
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
annevk
reviewed
Sep 30, 2021
source
Outdated
| elements should not be used to display transparent images, as such images rarely convey meaning and | ||
| rarely add anything useful to the document.</p> | ||
| elements should not be used to display transparent images, as such images rarely convey meaning | ||
| and don't add anything useful to the document.</p> |
There was a problem hiding this comment.
Didn't I comment on this already? Do these PRs overlap?
source
Outdated
| @@ -40382,7 +40384,7 @@ interface <dfn interface>HTMLTableElement</dfn> : <span>HTMLElement</span> { | |||
| <p>There are a variety of ways to include this information, such as:</p> | |||
|
|
|||
| <dl> | |||
| <dt>In prose, surrounding the table</dt> | |||
| <dt>In prose, surrounding the table:</dt> | |||
There was a problem hiding this comment.
I think the current style reads a little better as this list was already introduced with a colon.
|
Thanks for the notes, @annevk—adjusted the formatting. |
annevk
reviewed
Oct 1, 2021
|
@annevk, any other feedback? (Thanks for working with me on this.) |
annevk
approved these changes
Oct 8, 2021
* Adjusted case (“wiki”—should otherwise be qualified for more clarity) * Rephrased “microformats wiki existing-rel-values page” (super-long, reads awkwardly) * Added article to make `source` element conditions more readable * Limited repetition (double “and so forth”) * Made layout/transparency note slightly more clear Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
* Remove unneeded commas to aid readability * Made code samples more consistent (closing all the respective paragraphs) * Added more (and more recent) CSS layout options * Added colons (to improve readability for some table examples) Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
* Removed superfluous copy (reads easier) * Made formatting consistent Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
* Removed superfluous “completely” [this change bleeds out of chapter 4, to keep it consistent across the spec] * Added “element” to make a clause read better * Added missing article (“the”) Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
* Removed example quotes (→ `id=p`) to make the example code consistent * Split up examples into several examples (which conveniently avoids questions on the original markup, which should otherwise use a list or at least paragraphs) * Made one example intro and outro read more fluidly (“in the snippet … the form owner …”) * Unquoted an expression where the quotes are confusing * Removed an unnecessary space in an example * Added a missing article (“_a_ script”) * Removed unnecessary space (“can not”) Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
… of one formatting correction) Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
|
No, all good! I should have looked at this before "the article" PR as that was redundant, but it was easy enough to resolve the conflict. |
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.
This PR includes more changes than I wanted it to include (had mentioned to @annevk and @domenic that I’m breaking these up), however chapter/section 4 has been such a carrot in front of me, I always thought “that’s about it.”
Will create a new PR for any remaining fixes and tweaks for chapter 4.
id=p) to make the example code consistentSigned-off-by: Jens Oliver Meiert jens@meiert.com
/canvas.html ( diff )
/form-control-infrastructure.html ( diff )
/form-elements.html ( diff )
/forms.html ( diff )
/images.html ( diff )
/input.html ( diff )
/interactive-elements.html ( diff )
/parsing.html ( diff )
/scripting.html ( diff )
/tables.html ( diff )