doc: clarification on the 'close' event

per: nodejs/node-v0.x-archive#8209 originally submitted by @jeromew Reviewed By: Sakthipriyan Vairamani <[email protected]> PR-URL: #2378
nodejs · Aug 26, 2015 · 52018e7 · 52018e7
1 parent f6d3b87
commit 52018e7
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
@@ -230,8 +230,11 @@ readable.on('end', function() {
 
 #### Event: 'close'
 
-Emitted when the underlying resource (for example, the backing file
-descriptor) has been closed. Not all streams will emit this.
+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.
+
+Not all streams will emit the 'close' event.
 
 #### Event: 'error'