Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix doc styles #13270

Closed
wants to merge 1 commit into from
Closed

Conversation

watilde
Copy link
Member

@watilde watilde commented May 28, 2017

Same with #13066. Fix markdown linter(#12756) warnings.

Summary

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
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

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 nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels May 28, 2017
@mscdex
Copy link
Contributor

mscdex commented May 28, 2017

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?

@watilde
Copy link
Member Author

watilde commented May 28, 2017

@mscdex Here is what we discussed about which case we should tweak changelogs: #12756 (comment).

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@watilde
Copy link
Member Author

watilde commented May 29, 2017

@watilde
Copy link
Member Author

watilde commented May 30, 2017

Landed in 1d60fc3. Thanks!

@watilde watilde closed this May 30, 2017
@watilde watilde deleted the feature/doc-linterrors branch May 30, 2017 17:20
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 <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
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 <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@jasnell jasnell mentioned this pull request Jun 5, 2017
@gibfahn gibfahn mentioned this pull request Jun 15, 2017
3 tasks
@MylesBorins
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants