Skip to content

Commit

Permalink
cosmetic doc improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
bjouhier committed Feb 7, 2012
1 parent b981b6d commit 17620c7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ This stream is writable (see Writable Stream above).

This is a wrapper around streams returned by TCP and socket clients:

These streams is both readable and writable (see Readable Stream and Writable Stream above).
These streams are both readable and writable (see Readable Stream and Writable Stream above).

* `stream = new streams.NetStream(stream, [options])`
creates a network stream wrapper.
Expand All @@ -273,7 +273,7 @@ These are wrappers around node's `net.createConnection`:

## try/finally wrappers and pump

* result = `streams.using(_, constructor, stream, [options,] fn)`
* `result = streams.using(_, constructor, stream, [options,] fn)`
wraps `stream` with an instance of `constructor`;
passes the wrapper to `fn(_, wrapped)` and closes the stream after `fn` returns.
`fn` is called inside a `try/finally` block to guarantee that the stream
Expand All @@ -283,7 +283,7 @@ These are wrappers around node's `net.createConnection`:
shortcut for streams.using(_, streams.ReadableStream, stream, options, fn)
* `result = streams.usingWritable(_, stream, [options,] fn)`
shortcut for streams.using(_, streams.WritableStream, stream, options, fn)
* `streams.pump(_, inStream, outStream)
* `streams.pump(_, inStream, outStream)`
Pumps from inStream to outStream
does not close the streams at the end.

Expand Down
6 changes: 3 additions & 3 deletions lib/streams/server/streams.js
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ exports.httpRequest = function(options) {
///
/// This is a wrapper around streams returned by TCP and socket clients:
///
/// These streams is both readable and writable (see Readable Stream and Writable Stream above).
/// These streams are both readable and writable (see Readable Stream and Writable Stream above).
///
/// * `stream = new streams.NetStream(stream, [options])`
/// creates a network stream wrapper.
Expand Down Expand Up @@ -655,7 +655,7 @@ function NetClient(options, args) {
///
/// ## try/finally wrappers and pump
///
/// * result = `streams.using(_, constructor, stream, [options,] fn)`
/// * `result = streams.using(_, constructor, stream, [options,] fn)`
/// wraps `stream` with an instance of `constructor`;
/// passes the wrapper to `fn(_, wrapped)` and closes the stream after `fn` returns.
/// `fn` is called inside a `try/finally` block to guarantee that the stream
Expand Down Expand Up @@ -684,7 +684,7 @@ exports.usingWritable = function(_, emitter, options, fn) {
return exports.using.call(this, _, exports.WritableStream, emitter, options, fn);
}

/// * `streams.pump(_, inStream, outStream)
/// * `streams.pump(_, inStream, outStream)`
/// Pumps from inStream to outStream
/// does not close the streams at the end.
exports.pump = function(_, inStream, outStream) {
Expand Down

0 comments on commit 17620c7

Please sign in to comment.