JS Docs: convert from HTML to markdown #73
Merged
Conversation
This file contains hidden or 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
Includes:
* Removing stray unicode artifacts.
* Improving formatting consistency in a couple of places.
I.e. having "Good"/"Bad" both wrapped in emphasis, having the `:` in lists not included in the bold tags, refering to the correct tags in some examples - most for `@deprecated`.
* Being more liberal with backticks around documentation `@tags`, like in the tables.
* Improving accessibility by not using "here" as link text.
* Removing trailing spaces.
**Notes**:
* The formatting around the `[tip]` should be double-checked as I'm not sure if the shortcode doesn't break now the contents is reformatted.
* There are a few "inline headers" (using `**` not `##..`) in the "Formatting Guidelines" section, about which I wonder if those shouldn't be changed to proper headers.
See: https://developer.wordpress.org/coding-standards/inline-documentation-standards/javascript/#formatting-guidelines
Also note that while I haven't really "read" the document, only scanned it, I did get the impression that there was quite a lot of redundancy/duplication in the text. MIght be something to have a look at/iterate on in a follow-up PR.
ntwb
approved these changes
May 2, 2022
Member
|
FYI:
Screenshot of the current |
Member
Author
|
Just checked - text has synced and |
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.
Includes:
I.e. having "Good"/"Bad" both wrapped in emphasis, having the
:in lists not included in the bold tags, refering to the correct tags in some examples - most for@deprecated.@tags, like in the tables.Notes:
[tip]should be double-checked as I'm not sure if the shortcode doesn't break now the contents is reformatted.**not##..) in the "Formatting Guidelines" section, about which I wonder if those shouldn't be changed to proper headers.See: https://developer.wordpress.org/coding-standards/inline-documentation-standards/javascript/#formatting-guidelines
Also note that while I haven't really "read" the document, only scanned it, I did get the impression that there was quite a lot of redundancy/duplication in the text. Might be something to have a look at/iterate on in a follow-up PR.