-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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: fix typos in the stream doc #7336
Conversation
While you’re at it, could you also take a look at the ones listed in #6947 (comment) ? |
Sorry, I am not a pro in the doc format and I've just found many more strange fragments:
And many method calls have strange slash in it (i.e. |
Nah, no need to close this. If you don’t feel like fixing the other issues, that’s perfectly fine – this LGTM anyway and I see no reason not to merge it.
That’s what reviews are for, so I wouldn’t worry about that. |
Fixed another one that I was confident to fix. Is it OK to add this second commit in this same PR this way? |
@vsemozhetbyt yes I think that's ok, whoever lands this will squash your commits if necessary. |
I've tried to fix another three typos from this coment. The first and second ones seem OK (but I am not sure if they really have proper hrefs now). The third I can't fix, sorry. I hope I have not fouled all the PR by the last tries. |
@@ -1848,7 +1848,7 @@ net.createServer((socket) => { | |||
|
|||
In addition to new Readable streams switching into flowing mode, | |||
pre-v0.10 style streams can be wrapped in a Readable class using the | |||
[`readable.wrap()`][] method. | |||
[`readable.wrap()`][stream-_wrap] method. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be [
readable.wrap()][
stream.wrap()]
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should be the backticks in the second brackets too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the footer of the file, there is a [
stream.wrap()]: #stream_readable_wrap_stream
line, so yes, I think so
LGTM with a comment |
Phew) Finally. |
Should I also replace all the |
The backslashes all show up in https://nodejs.org/api/stream.html, right? If so, I’d be in favour of that. |
Yes, they show up there. So are they somehow OK or they should be deleted? |
They should be removed, yes. |
Done. Hope nothing is broken after this mass replace (I've done it one by one with a check). |
btw, you can run |
Sorry. I've restored backslashes in headers. Is it OK now? |
@vsemozhetbyt looks good, yep |
LGTM |
Landed in 58a241d, thanks! |
PR-URL: #7336 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #7336 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #7336 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
Checklist
Affected core subsystem(s)
doc
Description of change
Fix typo in the link to
fs
method documentation.