Skip to content

Commit

Permalink
doc: minor additional corrections and improvements
Browse files Browse the repository at this point in the history
Per feedback from @thefourtheye: (a) improve word on the
description of the `close` event in stream.markdown and
(b) remove `[module section]: modules.html` from
globals.markdown

Reviewed By: Sakthipriyan Vairamani <[email protected]>
PR-URL: #2378
  • Loading branch information
jasnell authored and rvagg committed Aug 26, 2015
1 parent 3bd08aa commit 2f62455
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
1 change: 0 additions & 1 deletion doc/api/globals.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,6 @@ will not execute.
The timer functions are global variables. See the [timers][] section.

[buffer section]: buffer.html
[module section]: modules.html
[module system documentation]: modules.html
[Modules]: modules.html#modules_modules
[process object]: process.html#process_process
Expand Down
4 changes: 2 additions & 2 deletions doc/api/stream.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,8 @@ readable.on('end', function() {
#### Event: 'close'

Emitted when the stream and any of its underlying resources (a file
descriptor, for example) have been closed, no more events will be
emitted, and no further computation will occur.
descriptor, for example) have been closed. The event indicates that
no more events will be emitted, and no further computation will occur.

Not all streams will emit the 'close' event.

Expand Down

0 comments on commit 2f62455

Please sign in to comment.