doc: fix typos in the stream doc

[vsemozhetbyt]

Checklist

• documentation is changed or added

Affected core subsystem(s)

doc

Description of change

Fix typo in the link to fs method documentation.

[addaleax]

While you’re at it, could you also take a look at the ones listed in #6947 (comment) ?

[vsemozhetbyt]

Sorry, I am not a pro in the doc format and I've just found many more strange fragments:

...Note: Transform streams provide their own implementation of the [writable._write()]...

...and may also implement the [transform._flush()][stream-._flush] method...

...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...

And many method calls have strange slash in it (i.e. writable.\_write()). I am afraid I could break the doc more than fix it. May be I should close this PR and wait for more well-informed contributor to fix all the typos.

[addaleax]

May be I should close this PR and wait for more well-informed contributor to fix all the typos.

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.

I am afraid I could break the doc more than fix it.

That’s what reviews are for, so I wouldn’t worry about that.

[vsemozhetbyt]

Fixed another one that I was confident to fix. Is it OK to add this second commit in this same PR this way?

[lpinca]

@vsemozhetbyt yes I think that's ok, whoever lands this will squash your commits if necessary.
I think you can do that yourself in this case (squash and force push).

[vsemozhetbyt]

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.

[addaleax]

This should be [readable.wrap()][stream.wrap()]?

[vsemozhetbyt]

There should be the backticks in the second brackets too?

[addaleax]

In the footer of the file, there is a [stream.wrap()]: #stream_readable_wrap_stream line, so yes, I think so

[addaleax]

LGTM with a comment

[vsemozhetbyt]

Phew) Finally.

[vsemozhetbyt]

Should I also replace all the writable.\_write and like ones with writable._write ? There are 35 ones in the source.

[addaleax]

The backslashes all show up in https://nodejs.org/api/stream.html, right? If so, I’d be in favour of that.

[vsemozhetbyt]

Yes, they show up there. So are they somehow OK or they should be deleted?

[addaleax]

They should be removed, yes.

[vsemozhetbyt]

Done. Hope nothing is broken after this mass replace (I've done it one by one with a check).

[addaleax]

btw, you can run make -j8 doc-only in your node checkout and look at the doc output directly (e.g. in out/doc/api/stream.html), if that helps you feel more confident about the changes you are making. :)

[vsemozhetbyt]

Sorry. I've restored backslashes in headers. Is it OK now?

[addaleax]

@vsemozhetbyt looks good, yep

[jasnell]

LGTM

[addaleax]

Landed in 58a241d, thanks!