Skip to content

doc: fix some descriptions of sync methods - #21747

Closed
timruffles wants to merge 2 commits into
nodejs:masterfrom
timruffles:patch-2
Closed

doc: fix some descriptions of sync methods#21747
timruffles wants to merge 2 commits into
nodejs:masterfrom
timruffles:patch-2

Conversation

@timruffles

@timrufflestimruffles commented Jul 11, 2018

Copy link
Copy Markdown
Contributor
Checklist

@nodejs-github-botnodejs-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

mscdex commented Jul 11, 2018

Copy link
Copy Markdown
Contributor

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

maclover7
maclover7 approved these changes Jul 11, 2018
View reviewed changes

@maclover7maclover7 left a comment

Copy link
Copy Markdown
Contributor

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

vsemozhetbyt commented Jul 11, 2018•
edited
Loading

Copy link
Copy Markdown
Contributor

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).

@BridgeARBridgeAR 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

BridgeAR commented Jul 12, 2018

Copy link
Copy Markdown
Member

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

@vsemozhetbyt

vsemozhetbyt commented Jul 17, 2018

Copy link
Copy Markdown
Contributor

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

@Trott

Trott commented Jul 18, 2018

Copy link
Copy Markdown
Member

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.

@BridgeARBridgeAR changed the title fs: fix readdirSync docs, doesn't accept a callbackdoc: fix readdirSync docs, doesn't accept a callbackJul 18, 2018
@vsemozhetbyt

vsemozhetbyt commented Jul 18, 2018

Copy link
Copy Markdown
Contributor

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

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

@vsemozhetbytvsemozhetbyt changed the title doc: fix readdirSync docs, doesn't accept a callbackdoc: fix some descriptions of sync methodsJul 18, 2018
@vsemozhetbyt

vsemozhetbyt commented Jul 20, 2018

Copy link
Copy Markdown
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

vsemozhetbyt commented Jul 21, 2018

Copy link
Copy Markdown
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>
@targostargos 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@addaleaxaddaleaxaddaleax approved these changes
@lpincalpincalpinca approved these changes
@cjihrigcjihrigcjihrig approved these changes
@BridgeARBridgeARBridgeAR approved these changes
@trivikrtrivikrtrivikr approved these changes
+2 more reviewers
@maclover7maclover7maclover7 approved these changes
@vsemozhetbytvsemozhetbytvsemozhetbyt approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.fsIssues 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.

12 participants

@timruffles@mscdex@vsemozhetbyt@BridgeAR@Trott@jasnell@addaleax@lpinca@cjihrig@maclover7@trivikr@nodejs-github-bot