Skip to content

doc, tools: unify stability signatures - #20552

Closed
vsemozhetbyt wants to merge 1 commit into
nodejs:masterfrom
vsemozhetbyt:doc-unify-stability
Closed

doc, tools: unify stability signatures#20552
vsemozhetbyt wants to merge 1 commit into
nodejs:masterfrom
vsemozhetbyt:doc-unify-stability

Conversation

@vsemozhetbyt

@vsemozhetbytvsemozhetbyt commented May 6, 2018

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

Currently, we format all stability signatures in blockquotes except just this place in documentation.md, where they are wrapped in code elements. I can assume that the cause is that markdown glues consecutive blockquotes into one element, which seems wrong for this fragment.

However, this divergence makes our MD-2-HTML converter check all the code elements for stability signatures, which is rather a significant overhead.

So this PR unifies stability signatures (separating consecutive blockquotes by comments) and frees the converter from the excess checks.

The visible result is completely identical to the previous one.

@vsemozhetbytvsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label May 6, 2018
@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels May 6, 2018
@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

@vsemozhetbytvsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 6, 2018

@trivikrtrivikr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Verified the final output in private branch

@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

Landed in 5f2b67d
Thank you for the reviews.

@vsemozhetbyt
vsemozhetbyt deleted the doc-unify-stability branch May 8, 2018 21:53
vsemozhetbyt added a commit that referenced this pull request May 8, 2018
PR-URL: #20552
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@vsemozhetbytvsemozhetbyt mentioned this pull request May 8, 2018
2 tasks
targos pushed a commit that referenced this pull request May 12, 2018
PR-URL: #20552
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@addaleaxaddaleax mentioned this pull request May 14, 2018
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.fast-trackPRs that do not need to wait for 48 hours to land.toolsIssues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@vsemozhetbyt@jasnell@lpinca@trivikr@nodejs-github-bot