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: escape brackets not used as markdown reference links #29809

Closed
wants to merge 1 commit into from
Closed

doc: escape brackets not used as markdown reference links #29809

wants to merge 1 commit into from

Conversation

nschonni
Copy link
Member

@nschonni nschonni commented Oct 2, 2019 •
edited
Loading

Split from #29558

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

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 2, 2019
@Trott
Copy link
Member

Trott commented Oct 4, 2019

@nodejs/documentation This could use some reviews.

BridgeAR
BridgeAR reviewed Oct 9, 2019
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

I am +-0 on this. I guess most collaborators think the same here?

@nschonni nschonni force-pushed the escape-brackets-in-docs branch 2 times, most recently from 2621fa3 to 080d8b1 Compare October 9, 2019 22:49
nschonni
nschonni commented Oct 9, 2019
View reviewed changes
doc/api/crypto.md
@@ -622,7 +622,7 @@ provided, `otherPublicKey` is expected to be a [`Buffer`][],
If `outputEncoding` is given a string is returned; otherwise, a
[`Buffer`][] is returned.

### diffieHellman.generateKeys([encoding])
### diffieHellman.generateKeys(\[encoding\])
Copy link
Member Author

@nschonni nschonni Oct 9, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

This escaping of the few instances [encoding] in the headings are the only functional difference that this rule caught. Before it was adding a hyperlink in the title because that bracket work is used as a reference link in this document

@nschonni
Copy link
Member Author

nschonni commented Oct 9, 2019

Resolved the few merge issues and pointed out the only instance where this fixes a rendering issue

@nschonni
doc: escape brackets not used as markdown reference links
d224e9b 
These can turn into links if reference links are added to the document
@Trott
Copy link
Member

Trott commented Oct 11, 2019

Presumably there's a lint rule that can be added/enabled for this?

@Trott
Copy link
Member

Trott commented Oct 11, 2019

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3986/

@Trott
Copy link
Member

Trott commented Oct 11, 2019 •
edited
Loading

There are probably many currently-open PRs that will add more unescaped brackets when they land. I'm OK with that, though, if there's a lint rule on the horizon. We can fix up those instances when the lint rule lands.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 11, 2019
@nschonni
Copy link
Member Author

It would be covered by some of the rules in nodejs/remark-preset-lint-node#21 that are currently disabled. I'll go check to see if some of them can be re-enabled with the PRs that landed

@Trott
Copy link
Member

Trott commented Oct 11, 2019

Landed in 81bc7b3

@Trott Trott closed this Oct 11, 2019
Trott pushed a commit that referenced this pull request Oct 11, 2019
@nschonni @Trott
doc: escape brackets not used as markdown reference links
81bc7b3 
These can turn into links if reference links are added to the document

PR-URL: #29809
Reviewed-By: Rich Trott <[email protected]>
@nschonni
Copy link
Member Author

nschonni commented Oct 11, 2019 •
edited
Loading

Oops, missed 2 in fs.md after the rebase, but i'll enable the rule anyway and update that PR nevemind, seems OK

@nschonni nschonni mentioned this pull request Oct 11, 2019
Merged
targos pushed a commit that referenced this pull request Oct 14, 2019
@nschonni @targos
doc: escape brackets not used as markdown reference links
b916ea3 
These can turn into links if reference links are added to the document

PR-URL: #29809
Reviewed-By: Rich Trott <[email protected]>
@nschonni nschonni mentioned this pull request Oct 14, 2019
Merged
3 tasks
@targos targos mentioned this pull request Oct 15, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR left review comments

@Trott Trott Trott approved these changes

Assignees
No one assigned
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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nschonni @Trott @BridgeAR @nodejs-github-bot