-
-
Notifications
You must be signed in to change notification settings - Fork 33.9k
Closed
Labels
docIssues and PRs related to the documentations.Issues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.Issues and PRs related to the fs subsystem / file system.
Description
- Version: all
- Platform: n/a
- Subsystem:
doc
Currently there is only a mention of a close event in the streams' Readable section of the docs. However in the fs docs, it is not mentioned that either fs.ReadStream or fs.WriteStream are some of the special streams that do emit close, but in fact both of them do emit close.
So I recommend two things:
- Explicitly document
closein the events sections forfs.ReadStreamandfs.WriteStream. - Either move the description/documentation about the
closeevent from thestreams.Readablesection to earlier in the document and explain it can be emitted by any kind of stream or copy the event description to at least thestreams.Writablesection.
Metadata
Metadata
Assignees
Labels
docIssues and PRs related to the documentations.Issues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.Issues and PRs related to the fs subsystem / file system.