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: prevent a false-positive linkification #19913

Closed
wants to merge 1 commit into from
Closed

doc: prevent a false-positive linkification #19913

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented Apr 10, 2018

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

This is an example of tricky doc issues we may have.

When we create too common bottom references, there are two dangers:

  1. Inside the module document, there can be false-positive linkification in function signatures and maybe other places. The linkification in signature deletes [] square brackets and optional parameters become mandatory. See examples: zlib.createDeflate([options]), zlib.createDeflateRaw([options]) and so on.

  2. When these references are merged into the all.html, the [] square brackets deletion is complicated with confusing wrong links. See examples (beware that all.html is a big file): new Agent([options]), new net.Socket([options]), os.userInfo([options]), repl.start([options]) etc. which currenty refer to zlib option class that is wrong.

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 10, 2018
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem. labels Apr 10, 2018
@vsemozhetbyt
Copy link
Contributor Author

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 10, 2018
vsemozhetbyt added a commit that referenced this pull request Apr 10, 2018
PR-URL: #19913
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@vsemozhetbyt
Copy link
Contributor Author

Landed in 5e68172

@vsemozhetbyt vsemozhetbyt deleted the doc-unlink-false-positive branch April 10, 2018 13:55
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request May 1, 2018
PR-URL: nodejs#19913
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@vsemozhetbyt vsemozhetbyt mentioned this pull request Jul 22, 2018
2 tasks
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. zlib Issues and PRs related to the zlib subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants