doc: fix doc styles #13270
Closed
doc: fix doc styles #13270
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
BUILDING.md + L122: Missing code-language flag + L170: Strong should use `*` as a marker doc/changelogs/CHANGELOG_V6.md + L1494: Don’t pad `emphasis` with inner spaces doc/guides/maintaining-V8.md + L3: Don’t use multiple top level headings + L16: Don’t use multiple top level headings + L40: Don’t use multiple top level headings + L124: Don’t use multiple top level headings + L182: Missing code-language flag + L223: Don’t use multiple top level headings + L288: Don’t use multiple top level headings + L307: Don’t use multiple top level headings doc/guides/writing-tests.md + L322: Missing code-language flag + L329: Missing code-language flag doc/releases.md + L299: Missing code-language flag
nodejs-github-bot
added
build
|
I don't think the changelog should be modified, since the original commit message in this case does not have backticks. Perhaps we should just make the entire commit list unformatted or similarly restricted? |
|
@mscdex Here is what we discussed about which case we should tweak changelogs: #12756 (comment). |
lpinca
approved these changes
May 29, 2017
aqrln
approved these changes
May 29, 2017
|
Landed in 1d60fc3. Thanks! |
watilde
added a commit
that referenced
this pull request
May 30, 2017
BUILDING.md + L122: Missing code-language flag + L170: Strong should use `*` as a marker doc/changelogs/CHANGELOG_V6.md + L1494: Don't pad `emphasis` with inner spaces doc/guides/maintaining-V8.md + L3: Don't use multiple top level headings + L16: Don't use multiple top level headings + L40: Don't use multiple top level headings + L124: Don't use multiple top level headings + L182: Missing code-language flag + L223: Don't use multiple top level headings + L288: Don't use multiple top level headings + L307: Don't use multiple top level headings doc/guides/writing-tests.md + L322: Missing code-language flag + L329: Missing code-language flag doc/releases.md + L299: Missing code-language flag PR-URL: #13270 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
jasnell
pushed a commit
that referenced
this pull request
Jun 5, 2017
BUILDING.md + L122: Missing code-language flag + L170: Strong should use `*` as a marker doc/changelogs/CHANGELOG_V6.md + L1494: Don't pad `emphasis` with inner spaces doc/guides/maintaining-V8.md + L3: Don't use multiple top level headings + L16: Don't use multiple top level headings + L40: Don't use multiple top level headings + L124: Don't use multiple top level headings + L182: Missing code-language flag + L223: Don't use multiple top level headings + L288: Don't use multiple top level headings + L307: Don't use multiple top level headings doc/guides/writing-tests.md + L322: Missing code-language flag + L329: Missing code-language flag doc/releases.md + L299: Missing code-language flag PR-URL: #13270 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Closed
3 tasks
|
This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace do-not-land if it is being backported |
This was referenced Jun 21, 2023
This was referenced Jun 21, 2023
This was referenced Jun 22, 2023
This was referenced Jun 22, 2023
This was referenced Jul 6, 2023
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.
Same with #13066. Fix markdown linter(#12756) warnings.
Summary
BUILDING.md
*as a markerdoc/changelogs/CHANGELOG_V6.md
emphasiswith inner spacesdoc/guides/maintaining-V8.md
doc/guides/writing-tests.md
doc/releases.md
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc