-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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
doc: Clarify fs.access works on directories too. #7113
Conversation
Fixes: #7110 This is maybe more verbose than needed, since the same information is repeated several times. An alternative, maybe a single short sentence at the beginning is better. E.g. > Tests a user's permissions for the file or directory specified by > path. All modes work for either files or directories. `mode` is...
Could you just change the first sentence to:
As you already did. Then, for |
No need to be so verbose about file vs. directory. They are all just paths.
@cjihrig simplified... Just noticed that my editor trimmed some trailing whitespace. I assume this is not a problem. |
|
||
- `fs.constants.F_OK` - File is visible to the calling process. This is useful | ||
- `fs.constants.F_OK` - Path is visible to the calling process. This is useful |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I meant use path
, formatted as code to reference the argument.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I should have realized... Fixed
LGTM |
following constants define the possible values of `mode`. It is possible to | ||
create a mask consisting of the bitwise OR of two or more values. | ||
Tests a user's permissions for the file or directory specified by `path`. | ||
`mode` is an optional integer that specifies the accessibility checks to be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/mode
is/The mode
argument is
Small nit, otherwise LGTM |
Still LGTM |
Landed in d976d66 |
This is not landing cleanly on the v6.x branch. @lance would you be interested in opening an additional PR targeting the v6.x branch? |
@evanlucas will do. A question. It's not clear to me if @jasnell's dcccbfd#diff-acabf706a8aa070a8796e3573f7e4678 is intended to land in v6.x. If so, the docs should refer to |
@lance yea, the linked pr is semver-minor so won't be landing until the next semver-minor bump |
Checklist
Affected core subsystem(s)
doc, fs
Description of change
Fixes: #7110
This is maybe more verbose than needed, since the same information is
repeated several times. An alternative, maybe a single short sentence at
the beginning is better. E.g.