doc: improve fs api descriptions#17679
Closed
evanlucas wants to merge 3 commits intonodejs:masterfrom
Closed
Conversation
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts.
addaleax
added
doc
addaleax
approved these changes
Dec 14, 2017
doc/api/fs.md
Outdated
|
|
||
| Asynchronous chmod(2). No arguments other than a possible exception are given | ||
| to the completion callback. | ||
| Asynchronously changes the mode of a file. No arguments other than a possible |
Member
There was a problem hiding this comment.
Maybe even go for “permissions” instead of “mode”? Is that clearer?
cjihrig
approved these changes
Dec 14, 2017
jasnell
reviewed
Dec 14, 2017
doc/api/fs.md
Outdated
| * `mode` {integer} | ||
|
|
||
| Synchronous chmod(2). Returns `undefined`. | ||
| The synchronous version of [`fs.chmod()`][]. Returns `undefined`. |
Member
There was a problem hiding this comment.
I know it duplicates content, but it would be ideal if this wasn't just a link to something else... e.g. this could be
Synchronously change the permissions of a file or throw if unable to do so.Likewise for the other *Sync variants.
Fishrock123
approved these changes
Dec 14, 2017
Contributor
Fishrock123
left a comment
Fishrock123
left a comment
There was a problem hiding this comment.
LGTM with @jasnell's suggestion.
lpinca
approved these changes
Dec 15, 2017
maclover7
approved these changes
Dec 18, 2017
Contributor
jasnell
approved these changes
Dec 21, 2017
Contributor
|
Landing... |
Contributor
|
Landed in 35511c8 |
Contributor
Author
|
@maclover7 thanks for landing! |
MylesBorins
pushed a commit
that referenced
this pull request
Jan 8, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 9, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 9, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
gibfahn
pushed a commit
that referenced
this pull request
Jan 24, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
gibfahn
pushed a commit
that referenced
this pull request
Jan 24, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
gibfahn
pushed a commit
that referenced
this pull request
Jan 24, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Feb 11, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 12, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 13, 2018
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir along with their *Sync counterparts. PR-URL: #17679 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir
along with their *Sync counterparts.
I have heard from many people how bad our docs are for people not familiar with some standard POSIX functions.
https://twitter.com/sindresorhus/status/939823222517850112 is just one example. I've also been told this in person on multiple occasions.
I think it is time for us to expand and improve our documentation to make it as useful as possible to all developers.
I know this isn't a large change but I do think it is an improvement over what we currently have.
I'm also open to wording/description suggestions.
Checklist
Affected core subsystem(s)
doc