Skip to content

doc: use code markup/markdown in headers#31149

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.

Sign up for GitHub

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

Jump to bottom
Closed
BridgeAR wants to merge 2 commits into from
Closed

doc: use code markup/markdown in headers #31149

BridgeAR wants to merge 2 commits into from

Conversation

@BridgeAR
Copy link
Member

@BridgeARBridgeAR commented Jan 1, 2020

This also allows us to remove backslash escaping for [ and ]
inside of header code, which makes the bare markdown more readable.

Refs: #31086

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@BridgeAR
doc: use code markup/markdown in headers
1d6728d
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: nodejs#31086
@BridgeARBridgeAR requested a review from TrottJanuary 1, 2020 16:56
@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 1, 2020
@antsmartianantsmartian added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 2, 2020
Trott
Trott reviewed Jan 2, 2020
View reviewed changes
Trott
Trott approved these changes Jan 2, 2020
View reviewed changes
Copy link
Member

@TrottTrott left a comment

Choose a reason for hiding this comment

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

LGTM with one nit

Trott pushed a commit that referenced this pull request Jan 4, 2020
@BridgeAR@Trott
doc: use code markup/markdown in headers
f64842a
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: #31086 PR-URL: #31149 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>
@Trott
Copy link
Member

Trott commented Jan 4, 2020

Landed in f64842a

@TrottTrott closed this Jan 4, 2020
targos pushed a commit that referenced this pull request Jan 6, 2020
@BridgeAR@targos
doc: use code markup/markdown in headers
dba2ab7
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: #31086 PR-URL: #31149 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>
@BridgeARBridgeAR mentioned this pull request Jan 7, 2020
Merged
targos pushed a commit that referenced this pull request Jan 14, 2020
@BridgeAR@targos
doc: use code markup/markdown in headers
39d49f5
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: #31086 PR-URL: #31149 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Jan 14, 2020
@BridgeAR@targos
doc: use code markup/markdown in headers
4bbf584
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: #31086 PR-URL: #31149 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>
@targostargos mentioned this pull request Jan 15, 2020
Closed
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
@BridgeAR@BethGriggs
doc: use code markup/markdown in headers
808f025
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: #31086 PR-URL: #31149 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>
@MylesBorinsMylesBorins mentioned this pull request Feb 8, 2020
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes

@TrottTrottTrott approved these changes

@lpincalpincalpinca approved these changes

@BethGriggsBethGriggsBethGriggs approved these changes

@trivikrtrivikrtrivikr approved these changes

+1 more reviewer

@antsmartianantsmartianantsmartian approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@BridgeAR@Trott@jasnell@antsmartian@lpinca@BethGriggs@trivikr@nodejs-github-bot