From 09768e306c829997fb93f40cb666ffb9a0af5551 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 21 Aug 2015 19:21:06 -0700 Subject: [PATCH] doc: minor additional corrections and improvements 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 PR-URL: https://github.com/nodejs/node/pull/2378 --- doc/api/globals.markdown | 1 - doc/api/stream.markdown | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown index 082ab3e784c..2a2140fe532 100644 --- a/doc/api/globals.markdown +++ b/doc/api/globals.markdown @@ -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 diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index 2022ef2f71d..a55098cd5e3 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -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.