Skip to content

doc: remove redundant parameter comments from fs

Rodrigo Muino Tomonari requested to merge github/fork/firedfox/remove-redundant-param-comments-from-fs-doc into master

Pull Request check-list

  • Does make -j8 test (UNIX) or vcbuild test nosign (Windows) pass with this change (including linting)?
  • Is the commit message formatted according to CONTRIBUTING.md?
  • If this change fixes a bug (or a performance problem), is a regression test (or a benchmark) included?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

Affected core subsystem(s)

  • doc

Description of change

Some old version parameter comments are left in the fs doc. Such as following path and callback at last:

## fs.readdir(path[, options], callback)

* `path` {String | Buffer}
* `options` {String | Object}
  * `encoding` {String} default = `'utf8'`
* `callback` {Function}

* `path` {String}
* `callback` {Function}

This change removes them.

See commit 060e5f0c and #5943 for reference.

Merge request reports