diff options
| author | Trevor Norris <trev.norris@gmail.com> | 2014-09-24 15:41:31 -0700 |
|---|---|---|
| committer | Trevor Norris <trev.norris@gmail.com> | 2014-09-25 11:26:15 -0700 |
| commit | 51b6b6844e9156ab84ae9d0f4592e09f994060b2 (patch) | |
| tree | 669ce8b9f1d556ab2b190268908e88107480d301 /doc/api/util.markdown | |
| parent | 8e4fc88c797857c55c84558708fa7e72bb7e4eca (diff) | |
| download | node-new-51b6b6844e9156ab84ae9d0f4592e09f994060b2.tar.gz | |
doc: fix brackets for optional parameters
Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:
fs.write(fd, data[, position[, encoding]], callback)
This simply fixes all uses of bracket notation in documentation.
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Fedor Indutny <fedor@indutny.com>
Diffstat (limited to 'doc/api/util.markdown')
| -rw-r--r-- | doc/api/util.markdown | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/util.markdown b/doc/api/util.markdown index dc6c0f64ee..cc639ddb49 100644 --- a/doc/api/util.markdown +++ b/doc/api/util.markdown @@ -43,7 +43,7 @@ environment variable set, then it will not print anything. You may separate multiple `NODE_DEBUG` environment variables with a comma. For example, `NODE_DEBUG=fs,net,tls`. -## util.format(format, [...]) +## util.format(format[, ...]) Returns a formatted string using the first argument as a `printf`-like format. @@ -81,7 +81,7 @@ Output with timestamp on `stdout`. require('util').log('Timestamped message.'); -## util.inspect(object, [options]) +## util.inspect(object[, options]) Return a string representation of `object`, which is useful for debugging. @@ -297,7 +297,7 @@ Deprecated predecessor of `console.log`. Deprecated predecessor of `console.log`. -## util.pump(readableStream, writableStream, [callback]) +## util.pump(readableStream, writableStream[, callback]) Stability: 0 - Deprecated: Use readableStream.pipe(writableStream) |