Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: remove redundant parameter comments from fs #5952

Conversation

firedfox
Copy link
Contributor

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 060e5f0 and #5943 for reference.

Some old version parameter comments are left in fs.markdown. Remove
them.
@mscdex mscdex added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Mar 30, 2016
@mscdex
Copy link
Contributor

mscdex commented Mar 30, 2016

LGTM

2 similar comments
@cjihrig
Copy link
Contributor

cjihrig commented Mar 30, 2016

LGTM

@eljefedelrodeodeljefe
Copy link
Contributor

LGTM

@silverwind
Copy link
Contributor

LGTM, landed in 4039ef1.

@silverwind silverwind closed this Mar 30, 2016
silverwind pushed a commit that referenced this pull request Mar 30, 2016
Some old version parameter comments are left in fs.markdown. Remove
them.

PR-URL: #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>
@silverwind
Copy link
Contributor

Not applicable for LTS because 060e5f0 that introduced the issue is a semver-major.

@MylesBorins
Copy link
Contributor

@silverwind in future if PR's are not applicable can you add the dont-land-on-v4.x label

Thanks for the hard work!!!

@jasnell
Copy link
Member

jasnell commented Apr 1, 2016

Quite odd. Glad this was caught. Thank you!

@MylesBorins
Copy link
Contributor

as far as I can tell it would seem like these changes are only applicable to master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants