Skip to content

tools: update JSON header parsing for backticks - #31294

Merged
Trott merged 1 commit into
nodejs:masterfrom
Trott:maybeBacktick
Jan 12, 2020
Merged

tools: update JSON header parsing for backticks#31294
Trott merged 1 commit into
nodejs:masterfrom
Trott:maybeBacktick

Conversation

@Trott

@TrottTrott commented Jan 10, 2020

Copy link
Copy Markdown
Member

Methods, events, and so on in headers in our documentation may (and
should) be set off with backticks in the raw markdown. When that
happens, the headers is misinterpreted by tools/json.js as not being a
method or event. Update the JSON tool generator to accommodate backticks
in this situation and add a test for this situation.

Fixes: #31290

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

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Jan 10, 2020
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@TrottTrott changed the title tools: update JSON header parsing for methodstools: update JSON header parsing for backticksJan 10, 2020
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@TrottTrott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 10, 2020
@Me1000

Copy link
Copy Markdown

@Trott thank you for taking care of this so quickly. I've run this locally and it appears to fix our issue!

Methods, events, and so on in headers in our documentation may (and
should) be set off with backticks in the raw markdown. When that
happens, the headers is misinterpreted by tools/json.js as not being a
method or event. Update the JSON tool generator to accommodate backticks
in this situation and add a test for this situation.
Fixes: nodejs#31290
PR-URL: nodejs#31294
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@Trott

Copy link
Copy Markdown
MemberAuthor

Landed in be46a72

@Trott
Trott merged commit be46a72 into nodejs:masterJan 12, 2020
@Trott
Trott deleted the maybeBacktick branch January 12, 2020 15:11
MylesBorins pushed a commit that referenced this pull request Jan 16, 2020
Methods, events, and so on in headers in our documentation may (and
should) be set off with backticks in the raw markdown. When that
happens, the headers is misinterpreted by tools/json.js as not being a
method or event. Update the JSON tool generator to accommodate backticks
in this situation and add a test for this situation.
Fixes: #31290
PR-URL: #31294
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebyterecodebytere mentioned this pull request Jan 16, 2020
codebytere pushed a commit that referenced this pull request Mar 14, 2020
Methods, events, and so on in headers in our documentation may (and
should) be set off with backticks in the raw markdown. When that
happens, the headers is misinterpreted by tools/json.js as not being a
method or event. Update the JSON tool generator to accommodate backticks
in this situation and add a test for this situation.
Fixes: #31290
PR-URL: #31294
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Mar 17, 2020
Methods, events, and so on in headers in our documentation may (and
should) be set off with backticks in the raw markdown. When that
happens, the headers is misinterpreted by tools/json.js as not being a
method or event. Update the JSON tool generator to accommodate backticks
in this situation and add a test for this situation.
Fixes: #31290
PR-URL: #31294
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebyterecodebytere mentioned this pull request Mar 17, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

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.toolsIssues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generated JSON documentation no longer includes methods field.

6 participants

@Trott@nodejs-github-bot@Me1000@addaleax@lpinca@richardlau