Skip to content

Fix fs & util docs - #18775

Closed
shqld wants to merge 3 commits into
nodejs:masterfrom
shqld:fix/doc-api
Closed

Fix fs & util docs#18775
shqld wants to merge 3 commits into
nodejs:masterfrom
shqld:fix/doc-api

Conversation

@shqld

@shqldshqld commented Feb 14, 2018•
edited
Loading

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

@starkwangstarkwang 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.

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
Comment threaddoc/api/fs.md Outdated
* `start` {integer}
* `end` {integer}
* `highWaterMark` {integer}
* Returns: {ReadStream}

@vsemozhetbytvsemozhetbytFeb 14, 2018

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.

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

@shqldshqldFeb 14, 2018

Copy link
Copy Markdown
Author

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!

Comment threaddoc/api/fs.md Outdated
* `mode` {integer}
* `autoClose` {boolean}
* `start` {integer}
* Returns: {WriteStream}

@vsemozhetbytvsemozhetbytFeb 14, 2018

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.

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

benjamingr
benjamingr requested changes Feb 14, 2018
View reviewed changes

@benjamingrbenjamingr left a comment

Copy link
Copy Markdown
Member

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

shqld commented Feb 14, 2018•
edited
Loading

Copy link
Copy Markdown
Author

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

@shqld

shqld commented Feb 14, 2018•
edited
Loading

Copy link
Copy Markdown
Author

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

@benjamingrbenjamingr left a comment

Copy link
Copy Markdown
Member

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

vsemozhetbyt commented Feb 14, 2018•
edited
Loading

Copy link
Copy Markdown
Contributor

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

@lpinca

lpinca commented Feb 14, 2018

Copy link
Copy Markdown
Member

Should we unify the formats?

Yes, I think it makes sense.

@shqld

shqld commented Feb 15, 2018•
edited
Loading

Copy link
Copy Markdown
Author

@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

lpinca commented Feb 15, 2018

Copy link
Copy Markdown
Member

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

@shqld

shqld commented Feb 15, 2018

Copy link
Copy Markdown
Author

I see! 😄

BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Feb 16, 2018
Sho Miyamoto@BridgeAR
doc: fix a typo in util.isDeepStrictEqual
ff471da
PR-URL: nodejs#18775
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Feb 16, 2018
Sho Miyamoto@BridgeAR
doc: add missing Returns in fs & util
9a18b0e
PR-URL: nodejs#18775
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
@BridgeAR

BridgeAR commented Feb 16, 2018

Copy link
Copy Markdown
Member

Landed in ff471da, 9a18b0e 🎉

@MylesBorins

MylesBorins commented Feb 21, 2018

Copy link
Copy Markdown
Contributor

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

shqld commented Feb 23, 2018

Copy link
Copy Markdown
Author

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
Sho Miyamoto@MylesBorins
doc: fix a typo in util.isDeepStrictEqual
4ecf5bb
Backport-PR-URL: #19127
PR-URL: #18775
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
Sho Miyamoto@MylesBorins
doc: add missing Returns in fs & util
e42600f
Backport-PR-URL: #19127
PR-URL: #18775
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
@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
Sho Miyamoto@MayaLekova
doc: fix a typo in util.isDeepStrictEqual
6b836ee
PR-URL: nodejs#18775
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
Sho Miyamoto@MayaLekova
doc: add missing Returns in fs & util
95759fb
PR-URL: nodejs#18775
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
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