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, tools: unify stability signatures #20552

Closed
wants to merge 1 commit into from
Closed

doc, tools: unify stability signatures #20552

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented May 6, 2018

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.

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label May 6, 2018
@nodejs-github-bot nodejs-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
Contributor Author

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

@vsemozhetbyt
Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 6, 2018
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.

Verified the final output in private branch

@vsemozhetbyt
Copy link
Contributor Author

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 <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
targos pushed a commit that referenced this pull request May 12, 2018
PR-URL: #20552
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@addaleax addaleax mentioned this pull request May 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants