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.

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

doc: guard against md list parsing edge case #19647

Closed
wants to merge 1 commit into from
Closed

doc: guard against md list parsing edge case #19647

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

This is funny (well, not so funny...) markdown list parsing edge case which erroneously adds a list and by a chance significantly perverts doc content in this situation (replace 0 by 1).

GitHub parses it correctly:

gh

marked plays a nasty trick:

marked

Not sure if we can guard against this proactively.

BTW: detected by chance during this investigation.

@vsemozhetbyt vsemozhetbyt added tools Issues and PRs related to the tools directory. fast-track PRs that do not need to wait for 48 hours to land. labels Mar 28, 2018
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels Mar 28, 2018
@vsemozhetbyt
Copy link
Contributor Author

CI will be performed after the end of the CI lockdown.

@vsemozhetbyt vsemozhetbyt mentioned this pull request Mar 28, 2018
Closed
trivikr
trivikr approved these changes Mar 28, 2018
View reviewed changes
Copy link
Member

@trivikr trivikr left a comment

Choose a reason for hiding this comment

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

Nice catch!

Trott
Trott approved these changes Mar 28, 2018
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

Nice catch. Difficult to guard against because the linter won't know the intention. Maybe someone is, in fact, trying to start a list. I suppose it could check to make sure the previous line ends with appropriate punctuation (either a : or .). Still, seems potentially brittle.

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Mar 28, 2018 •
edited
Loading

@Trott Maybe it is worth to warn about all the lists started not from 1. number? 1. will still be tricky, but this will reduce the danger.

@vsemozhetbyt
Copy link
Contributor Author

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/353/

vsemozhetbyt added a commit that referenced this pull request Mar 28, 2018
@vsemozhetbyt
doc: guard against md list parsing edge case
7e07687 
PR-URL: #19647
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Chen Gang <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@vsemozhetbyt
Copy link
Contributor Author

Landed in 7e07687

@vsemozhetbyt vsemozhetbyt deleted the doc-http2-list-edge-case branch March 28, 2018 21:25
targos pushed a commit that referenced this pull request Apr 2, 2018
@vsemozhetbyt @targos
doc: guard against md list parsing edge case
0786161 
PR-URL: #19647
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Chen Gang <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@targos targos mentioned this pull request Apr 4, 2018
Merged
kjin pushed a commit to kjin/node that referenced this pull request May 1, 2018
@vsemozhetbyt @kjin
doc: guard against md list parsing edge case
0682140 
PR-URL: nodejs#19647
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Chen Gang <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request May 2, 2018
@vsemozhetbyt @MylesBorins
doc: guard against md list parsing edge case
22eddf1 
Backport-PR-URL: #20456
PR-URL: #19647
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Chen Gang <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins MylesBorins mentioned this pull request May 2, 2018
Merged
MylesBorins pushed a commit that referenced this pull request May 15, 2018
@vsemozhetbyt @MylesBorins
doc: guard against md list parsing edge case
5989321 
Backport-PR-URL: #20456
PR-URL: #19647
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Chen Gang <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request May 15, 2018
@vsemozhetbyt @MylesBorins
doc: guard against md list parsing edge case
1ff3544 
Backport-PR-URL: #20456
PR-URL: #19647
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Chen Gang <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@lpinca lpinca lpinca approved these changes

@TimothyGu TimothyGu TimothyGu approved these changes

@cjihrig cjihrig cjihrig approved these changes

@MoonBall MoonBall MoonBall approved these changes

@trivikr trivikr trivikr approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. http2 Issues or PRs related to the http2 subsystem. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@vsemozhetbyt @jasnell @Trott @lpinca @TimothyGu @cjihrig @MoonBall @trivikr @nodejs-github-bot