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.

Sign up for GitHub

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

Jump to bottom

doc: fix some descriptions of sync methods #21747

Closed
wants to merge 2 commits into from
Closed

doc: fix some descriptions of sync methods #21747

wants to merge 2 commits into from

Conversation

timruffles
Copy link
Contributor

Checklist

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Jul 11, 2018
@mscdex
Copy link
Contributor

mscdex commented Jul 11, 2018

The prefix in the commit message should be doc: instead of fs:.

maclover7
maclover7 approved these changes Jul 11, 2018
View reviewed changes
Copy link
Contributor

@maclover7 maclover7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/250/

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Jul 11, 2018 •
edited
Loading

It seems the same issue can be fixed in the fs.readlinkSync() and fs.realpathSync.native(). You can amend a commit or add a new commit if you please (updating the PR title).

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 12, 2018
@BridgeAR
Copy link
Member

It would be great if the other entries would be fixed as well :-)

@vsemozhetbyt
Copy link
Contributor

How can we proceed? Can we fix other cases on landing?

@Trott
Copy link
Member

Trott commented Jul 18, 2018

How can we proceed? Can we fix other cases on landing?

@vsemozhetbyt In my opinion, any of the following are good approaches:

  • Land this and open a separate PR to fix the other two instances
  • Land this and open a new issue about the other two instances, perhaps labeling it "good first contribution"
  • Add your own commit to this branch/PR fixing the other two instances. You'll need to re-run the lite CI and it's probably a good idea to get at least one reviewer to reaffirm their approval with the additional changes.

@BridgeAR BridgeAR changed the title fs: fix readdirSync docs, doesn't accept a callback doc: fix readdirSync docs, doesn't accept a callback Jul 18, 2018
@vsemozhetbyt
Copy link
Contributor

I've pushed an additional commit. Dear reviewers, PTAL.

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/915/

@vsemozhetbyt vsemozhetbyt changed the title doc: fix readdirSync docs, doesn't accept a callback doc: fix some descriptions of sync methods Jul 18, 2018
@vsemozhetbyt
Copy link
Contributor

I will land this tomorrow if there are no objections or corrections.

vsemozhetbyt pushed a commit that referenced this pull request Jul 21, 2018
@timruffles @vsemozhetbyt
doc: fix descriptions of sync methods in fs.md
2d48f97 
PR-URL: #21747
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@vsemozhetbyt
Copy link
Contributor

Landed in 2d48f97
Thank you!

targos pushed a commit that referenced this pull request Jul 21, 2018
@timruffles @targos
doc: fix descriptions of sync methods in fs.md
eabe907 
PR-URL: #21747
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@targos targos mentioned this pull request Jul 31, 2018
Merged
This was referenced Aug 1, 2018
Closed
Closed
Closed
This was referenced Aug 2, 2018
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@maclover7 maclover7 maclover7 approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@trivikr trivikr trivikr approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet