doc: prevent a false-positive linkification #19913
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
vsemozhetbyt added the fast-track 
nodejs-github-bot added doc 
Contributor Author
cjihrig approved these changes Apr 10, 2018
BridgeAR approved these changes Apr 10, 2018
BridgeAR added the author ready 
lpinca approved these changes 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>
Contributor Author
| Landed in 5e68172 |
3 tasks
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>
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesThis is an example of tricky doc issues we may have.
When we create too common bottom references, there are two dangers:
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.When these references are merged into the
all.html, the[]square brackets deletion is complicated with confusing wrong links. See examples (beware thatall.htmlis a big file):new Agent([options]),new net.Socket([options]),os.userInfo([options]),repl.start([options])etc. which currenty refer tozliboptionclass that is wrong.