Browse Source

doc: remove redundant parameter comments from fs

Some old version parameter comments are left in fs.markdown. Remove
them.

PR-URL: https://github.com/nodejs/node/pull/5952
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
process-exit-stdio-flushing
firedfox 9 years ago
committed by silverwind
parent
commit
4039ef1a58
  1. 10
      doc/api/fs.markdown

10
doc/api/fs.markdown

@ -821,9 +821,6 @@ The callback is given the three arguments, `(err, bytesRead, buffer)`.
* `encoding` {String} default = `'utf8'` * `encoding` {String} default = `'utf8'`
* `callback` {Function} * `callback` {Function}
* `path` {String}
* `callback` {Function}
Asynchronous readdir(3). Reads the contents of a directory. Asynchronous readdir(3). Reads the contents of a directory.
The callback gets two arguments `(err, files)` where `files` is an array of The callback gets two arguments `(err, files)` where `files` is an array of
the names of the files in the directory excluding `'.'` and `'..'`. the names of the files in the directory excluding `'.'` and `'..'`.
@ -839,8 +836,6 @@ the filenames returned will be passed as `Buffer` objects.
* `options` {String | Object} * `options` {String | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {String} default = `'utf8'`
* `path` {String}
Synchronous readdir(3). Returns an array of filenames excluding `'.'` and Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
`'..'`. `'..'`.
@ -900,9 +895,6 @@ string. Otherwise it returns a buffer.
* `encoding` {String} default = `'utf8'` * `encoding` {String} default = `'utf8'`
* `callback` {Function} * `callback` {Function}
* `path` {String}
* `callback` {Function}
Asynchronous readlink(2). The callback gets two arguments `(err, Asynchronous readlink(2). The callback gets two arguments `(err,
linkString)`. linkString)`.
@ -917,8 +909,6 @@ the link path returned will be passed as a `Buffer` object.
* `options` {String | Object} * `options` {String | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {String} default = `'utf8'`
* `path` {String}
Synchronous readlink(2). Returns the symbolic link's string value. Synchronous readlink(2). Returns the symbolic link's string value.
The optional `options` argument can be a string specifying an encoding, or an The optional `options` argument can be a string specifying an encoding, or an

Loading…
Cancel
Save