Skip to content
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

doc: add section in fs to document mode argument #20049

Closed
trivikr opened this issue Apr 15, 2018 · 3 comments
Closed

doc: add section in fs to document mode argument #20049

trivikr opened this issue Apr 15, 2018 · 3 comments
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. good first issue Issues that are suitable for first-time contributors.

Comments

@trivikr
Copy link
Member

trivikr commented Apr 15, 2018

  • Version: master
  • Platform: N/A
  • Subsystem: fs

I noticed this while reviewing #20042
The description of mode argument is repeated in fs.access() and fs.accessSync(), and can be moved to a single location.

WDYT @nodejs/fs? This would be a good first issue for a new contributor.
@trivikr trivikr added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 15, 2018
@musgravejw
Copy link
Contributor

Aren't these constants defined here?

Perhaps the documentation could link to the existing constants list.

@trivikr
Copy link
Member Author

trivikr commented May 5, 2018

Yup.

But the following values will have to be added to the table:

  • F_OK - This is useful for determining if a file exists, but says nothing about rwx permissions. Default if no mode is specified.
  • X_OK - This has no effect on Windows (will behave like F_OK)

@trivikr trivikr added the good first issue Issues that are suitable for first-time contributors. label May 5, 2018
@shobhitchittora
Copy link
Contributor

@trivikr I'm on it.

shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 6, 2018
@shobhitchittora
doc: updates fs doc with -
37abf87 
1. removed extra mode constants doc
2. creates bookmark to the common File Access Contants block.

Closes: nodejs#20049
@shobhitchittora shobhitchittora mentioned this issue May 6, 2018
Closed
2 tasks
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 7, 2018
@shobhitchittora
doc: review comments
91bb735 
1. use <code> tag
2. bottom bookmark for File Access Constants
3. typo fix

Closes: nodejs#20049
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 7, 2018
@shobhitchittora
doc: removes repetition for fsPromises.access
563b406 
Closes: nodejs#20049
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 7, 2018
@shobhitchittora
doc: grammar fix ( adds 'of' ).
d42adec 
Refs: nodejs#20049
targos pushed a commit that referenced this issue May 12, 2018
@shobhitchittora @targos
doc: refactor mode constants parts in fs.md
d327893 
1. removed extra mode constants doc.
2. creates bookmark to the common File Access Contants block.

PR-URL: #20558
Fixes: #20049
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@musgravejw @shobhitchittora @trivikr