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: many erroneous linkifications #17694

Closed
PixnBits opened this issue Dec 15, 2017 · 4 comments
Closed

doc: many erroneous linkifications #17694

PixnBits opened this issue Dec 15, 2017 · 4 comments
Labels
confirmed-bug Issues with confirmed bugs. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.

Comments

@PixnBits
Copy link

  • Version: 9.3.0
  • Platform: N/A
  • Subsystem: N/A

The NodeJS v9.x API docs for stream have a heading that is literally <a href="http://man7.org/linux/man-pages/man0/readable.read.0.html">readable.read(0)</a> instead of the readable.read(0) from previous versions.
I'd have opened a PR but I don't know where the extra characters are coming from: the source code in both the master and v9.3.0 branches show the line unchanged for two years.
Apologies if this has already been corrected, github searches yielded no results for either code or issues relating to man7.
@vsemozhetbyt
Copy link
Contributor

Possible cause: #17479
See also #17637

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Dec 15, 2017 •
edited

There are many others such issues (for buf.fill(0), server.listen(0), process.exit(0), process.argv.slice(2), list(5)). You can search for man7 in this "all-docs" nightly page.

cc @DiegoRBaquero

@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Dec 15, 2017
@vsemozhetbyt vsemozhetbyt mentioned this issue Dec 15, 2017
Closed
@vsemozhetbyt vsemozhetbyt changed the title stream doc header malformed doc: many erroneous linkifications Dec 15, 2017
@Fishrock123 Fishrock123 added the confirmed-bug Issues with confirmed bugs. label Dec 15, 2017
DiegoRBaquero added a commit to DiegoRBaquero/node that referenced this issue Dec 18, 2017
@DiegoRBaquero
tools: fix man pages linking regex
5af4822 
The change to word boundary was breaking many doc pages. This reverts the word boundary back to space.

Fixes: nodejs#17637
Fixes: nodejs#17694
Refs: nodejs#17479
@DiegoRBaquero DiegoRBaquero mentioned this issue Dec 18, 2017
Closed
1 task
DiegoRBaquero added a commit to DiegoRBaquero/node that referenced this issue Dec 19, 2017
@DiegoRBaquero
tools: fix man pages linking regex
fa42177 
The change to word boundary was breaking many doc pages. This replace the word boundary with a matching group of space or beginning of line.

Fixes: nodejs#17637
Fixes: nodejs#17694
Refs: nodejs#17479
MylesBorins pushed a commit that referenced this issue Jan 8, 2018
@DiegoRBaquero @MylesBorins
tools: fix man pages linking regex
d2699cf 
The change to word boundary was breaking many doc pages. This reverts
the word boundary back to space.

PR-URL: #17724
Fixes: #17694
Refs: #17479
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue Jan 9, 2018
@DiegoRBaquero @MylesBorins
tools: fix man pages linking regex
22d755e 
The change to word boundary was breaking many doc pages. This reverts
the word boundary back to space.

PR-URL: #17724
Fixes: #17694
Refs: #17479
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue Jan 9, 2018
@DiegoRBaquero @MylesBorins
tools: fix man pages linking regex
7ef876d 
The change to word boundary was breaking many doc pages. This reverts
the word boundary back to space.

PR-URL: #17724
Fixes: #17694
Refs: #17479
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MoonBall
Copy link
Member

@vsemozhetbyt The doc of v8.9.4 has the same problem. see https://nodejs.org/dist/latest-v8.x/docs/api/stream.html

@vsemozhetbyt
Copy link
Contributor

@MoonBall Thank you. Reported: #17724 (comment)

@vsemozhetbyt vsemozhetbyt mentioned this issue Jan 24, 2018
Merged
gibfahn pushed a commit that referenced this issue Jan 24, 2018
@DiegoRBaquero @gibfahn
tools: fix man pages linking regex
ee027ae 
The change to word boundary was breaking many doc pages. This reverts
the word boundary back to space.

PR-URL: #17724
Fixes: #17694
Refs: #17479
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
gibfahn pushed a commit that referenced this issue Jan 24, 2018
@DiegoRBaquero @gibfahn
tools: fix man pages linking regex
90fe169 
The change to word boundary was breaking many doc pages. This reverts
the word boundary back to space.

PR-URL: #17724
Fixes: #17694
Refs: #17479
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
confirmed-bug Issues with confirmed bugs. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Fishrock123 @PixnBits @vsemozhetbyt @MoonBall