Skip to content

Fix fs & util docs#18775

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
Closed
shqld wants to merge 3 commits into from
Closed

Fix fs & util docs #18775

shqld wants to merge 3 commits into from

Conversation

@shqld
Copy link

@shqldshqld commented Feb 14, 2018•
edited
Loading

Overview
  • Fixed typo in util.isDeepStrictEqual of doc/api/util.md.
  • Added missing return value specifications in doc/api/fs.md & util.md.
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 14, 2018
@hiroppyhiroppy added util Issues and PRs related to the built-in util module. fs Issues and PRs related to the fs subsystem / file system. labels Feb 14, 2018
starkwang
starkwang approved these changes Feb 14, 2018
View reviewed changes
Copy link
Contributor

@starkwangstarkwang left a comment

Choose a reason for hiding this comment

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

LGTM

@BridgeARBridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 14, 2018
vsemozhetbyt
vsemozhetbyt reviewed Feb 14, 2018
View reviewed changes
doc/api/fs.md Outdated
*`start`{integer}
*`end`{integer}
*`highWaterMark`{integer}
* Returns:{ReadStream}
Copy link
Contributor

@vsemozhetbytvsemozhetbytFeb 14, 2018

Choose a reason for hiding this comment

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

Should be {stream.Readable}
See type-parser.js#L81-L84

Copy link
Author

@shqldshqldFeb 14, 2018

Choose a reason for hiding this comment

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

Thank you for your kind pointing out!

doc/api/fs.md Outdated
*`mode`{integer}
*`autoClose`{boolean}
*`start`{integer}
* Returns:{WriteStream}
Copy link
Contributor

@vsemozhetbytvsemozhetbytFeb 14, 2018

Choose a reason for hiding this comment

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

Should be {stream.Writable}
See type-parser.js#L81-L84

benjamingr
benjamingr requested changes Feb 14, 2018
View reviewed changes
Copy link
Member

@benjamingrbenjamingr left a comment

Choose a reason for hiding this comment

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

Thanks for this, going to block so this doesn't land with ReadStream and WriteStream by mistake - looks good other than that

@shqld
Copy link
Author

shqld commented Feb 14, 2018•
edited
Loading

@benjamingr@vsemozhetbyt I added a fixing commit about stream type name! Please confirm it 🙇

@shqld
Copy link
Author

shqld commented Feb 14, 2018•
edited
Loading

By the way, I wonder that specifying like Returns:{undefined} (e.g. in this part) is a little confusing because other functions which return nothing doesn't have things like that.
Should we unify the formats?

benjamingr
benjamingr approved these changes Feb 14, 2018
View reviewed changes
Copy link
Member

@benjamingrbenjamingr left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Feb 14, 2018•
edited
Loading

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

@lpinca
Copy link
Member

lpinca commented Feb 14, 2018

Should we unify the formats?

Yes, I think it makes sense.

@shqld
Copy link
Author

shqld commented Feb 15, 2018•
edited
Loading

@lpinca Thanks! Then I'm gonna remove them. But there are 12 Returns:{undefined} in doc/ so should I do that in another PR or can I do here?

@lpinca
Copy link
Member

lpinca commented Feb 15, 2018

@shqld It's probably better to use a dedicated PR.

@shqld
Copy link
Author

shqld commented Feb 15, 2018

I see! 😄

BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Feb 16, 2018
@BridgeAR
doc: fix a typo in util.isDeepStrictEqual
ff471da
PR-URL: nodejs#18775 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Feb 16, 2018
@BridgeAR
doc: add missing Returns in fs & util
9a18b0e
PR-URL: nodejs#18775 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
@BridgeAR
Copy link
Member

BridgeAR commented Feb 16, 2018

Landed in ff471da, 9a18b0e 🎉

@MylesBorins
Copy link
Contributor

MylesBorins commented Feb 21, 2018

Should this be backported to v9.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

@shqldshqld mentioned this pull request Feb 23, 2018
Closed
3 tasks
@shqld
Copy link
Author

shqld commented Feb 23, 2018

I think it should. I'll do that.

@shqldshqld mentioned this pull request Mar 4, 2018
Closed
3 tasks
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
@MylesBorins
doc: fix a typo in util.isDeepStrictEqual
4ecf5bb
Backport-PR-URL: #19127 PR-URL: #18775 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
@MylesBorins
doc: add missing Returns in fs & util
e42600f
Backport-PR-URL: #19127 PR-URL: #18775 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
@MylesBorinsMylesBorins mentioned this pull request Mar 6, 2018
Merged
@targostargos added backported-to-v9.x and removed backport-requested-v9.x author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Mar 24, 2018
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@MayaLekova
doc: fix a typo in util.isDeepStrictEqual
6b836ee
PR-URL: nodejs#18775 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@MayaLekova
doc: add missing Returns in fs & util
95759fb
PR-URL: nodejs#18775 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes

@benjamingrbenjamingrbenjamingr approved these changes

@lpincalpincalpinca approved these changes

@BridgeARBridgeARBridgeAR approved these changes

+4 more reviewers

@silverwindsilverwindsilverwind approved these changes

@daynindaynindaynin approved these changes

@vsemozhetbytvsemozhetbytvsemozhetbyt approved these changes

@starkwangstarkwangstarkwang approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.utilIssues and PRs related to the built-in util module.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

13 participants

@shqld@vsemozhetbyt@lpinca@BridgeAR@MylesBorins@silverwind@jasnell@daynin@benjamingr@starkwang@targos@hiroppy@nodejs-github-bot