doc: minor additional corrections and improvements
authorJames M Snell <jasnell@gmail.com>
Sat, 22 Aug 2015 02:21:06 +0000 (19:21 -0700)
committerJames M Snell <jasnell@gmail.com>
Wed, 26 Aug 2015 01:52:52 +0000 (18:52 -0700)
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 <thechargingvolcano@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/2378

doc/api/globals.markdown
doc/api/stream.markdown

index 082ab3e..2a2140f 100644 (file)
@@ -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
index 2022ef2..a55098c 100644 (file)
@@ -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.