doc: updates fs doc ( refactors file access constants ) #20558

shobhitchittora · 2018-05-06T07:38:08Z

removes extra mode constants doc from fs.access and fs.accessSync.
creates bookmark to the common File Access Contants block.

Closes: #20049

documentation is changed or added
commit message follows commit guidelines

1. removed extra mode constants doc 2. creates bookmark to the common File Access Contants block. Closes: nodejs#20049

trivikr · 2018-05-06T15:19:46Z

doc/api/fs.md

-    <td>Flag indicating that the file is visible to the calling process.</td>
+    <td>Flag indicating that the file is visible to the calling process.
+     This is useful for determining if a file exists, but says nothing
+     about rwx permissions. Default if no mode is specified.</td>


rwx -> rwx
mode -> mode

Hey @trivikr. I don't think markdown highlight `` will work inside HTML tags. Refer - https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#inline-html

You can use <code></code> here and below.

trivikr · 2018-05-06T15:20:32Z

doc/api/fs.md

@@ -4343,7 +4330,8 @@ The following constants are meant for use with [`fs.access()`][].
  <tr>
    <td><code>X_OK</code></td>
    <td>Flag indicating that the file can be executed by the calling
-    process.</td>
+    process. This has no effect on Windows
+    (will behave like fs.constants.F_OK).</td>


fs.constants.F_OK -> fs.constants.F_OK

same as above.

trivikr · 2018-05-06T15:21:03Z

@nodejs/fs @nodejs/documentation

vsemozhetbyt · 2018-05-06T19:46:20Z

doc/api/fs.md

@@ -746,18 +746,11 @@ changes:

 Tests a user's permissions for the file or directory specified by `path`.
 The `mode` argument is an optional integer that specifies the accessibility
-checks to be performed. The following constants define the possible values of
+checks to be performed. Check
+[`File Access Contants`](#fs_file_access_constants) for possible values of


Contants -> Constants

Also, [`File Access Contants`] -> just [File Access Contants] (as this is not a code)?

vsemozhetbyt · 2018-05-06T19:47:56Z

doc/api/fs.md

@@ -891,18 +884,10 @@ changes:

 Synchronously tests a user's permissions for the file or directory specified by
 `path`. The `mode` argument is an optional integer that specifies the
-accessibility checks to be performed. The following constants define the
+accessibility checks to be performed. Check [`File Access Contants`](#fs_file_access_constants) for


Contants -> Constants

This line needs to be wrapped at 80 characters. Or you can create a bottom reference and use [File Access Constants][].

vsemozhetbyt · 2018-05-06T19:53:19Z

doc/api/fs.md

-    <td>Flag indicating that the file is visible to the calling process.</td>
+    <td>Flag indicating that the file is visible to the calling process.
+     This is useful for determining if a file exists, but says nothing
+     about rwx permissions. Default if no mode is specified.</td>


You can use <code></code> here and below.

vsemozhetbyt · 2018-05-06T19:55:47Z

There is one more repetition in the fsPromises.access(path[, mode]) section)

1. use <code> tag 2. bottom bookmark for File Access Constants 3. typo fix Closes: nodejs#20049

Closes: nodejs#20049

shobhitchittora · 2018-05-07T06:21:22Z

@vsemozhetbyt done for fsPromises.access.

trivikr

Verified the update in private branch

shobhitchittora · 2018-05-07T08:57:14Z

doc/api/fs.md

-* `fs.constants.W_OK` - `path` can be written by the calling process.
-* `fs.constants.X_OK` - `path` can be executed by the calling process. This has
-no effect on Windows (will behave like `fs.constants.F_OK`).
+checks to be performed. Check [File Access Constants][] for possible values


Refs: nodejs#20049

vsemozhetbyt · 2018-05-07T10:04:39Z

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

vsemozhetbyt · 2018-05-07T10:05:22Z

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

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 <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

vsemozhetbyt · 2018-05-08T21:37:51Z

Landed in a76dfd2
Thank you!

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 <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

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

nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels May 6, 2018

trivikr reviewed May 6, 2018

View reviewed changes

vsemozhetbyt reviewed May 6, 2018

View reviewed changes

shobhitchittora added 2 commits May 7, 2018 11:46

doc: review comments

91bb735

1. use <code> tag 2. bottom bookmark for File Access Constants 3. typo fix Closes: nodejs#20049

doc: removes repetition for fsPromises.access

563b406

Closes: nodejs#20049

trivikr approved these changes May 7, 2018

View reviewed changes

vsemozhetbyt reviewed May 7, 2018

View reviewed changes

doc: grammar fix ( adds 'of' ).

d42adec

Refs: nodejs#20049

vsemozhetbyt approved these changes May 7, 2018

View reviewed changes

vsemozhetbyt added fast-track PRs that do not need to wait for 48 hours to land. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels May 7, 2018

vsemozhetbyt closed this May 8, 2018

addaleax mentioned this pull request May 14, 2018

v10.2.0 proposal #20724

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: updates fs doc ( refactors file access constants ) #20558

doc: updates fs doc ( refactors file access constants ) #20558

shobhitchittora commented May 6, 2018 •

edited

Loading

trivikr May 6, 2018

shobhitchittora May 6, 2018

vsemozhetbyt May 6, 2018

trivikr May 6, 2018

shobhitchittora May 6, 2018

trivikr commented May 6, 2018

vsemozhetbyt May 6, 2018

vsemozhetbyt May 7, 2018 •

edited

Loading

vsemozhetbyt May 6, 2018 •

edited

Loading

vsemozhetbyt May 6, 2018

vsemozhetbyt commented May 6, 2018

shobhitchittora commented May 7, 2018

trivikr left a comment

This comment was marked as resolved.

shobhitchittora May 7, 2018

vsemozhetbyt commented May 7, 2018

vsemozhetbyt commented May 7, 2018

vsemozhetbyt commented May 8, 2018

doc: updates fs doc ( refactors file access constants ) #20558

doc: updates fs doc ( refactors file access constants ) #20558

Conversation

shobhitchittora commented May 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trivikr commented May 6, 2018

Choose a reason for hiding this comment

vsemozhetbyt May 7, 2018 • edited Loading

Choose a reason for hiding this comment

vsemozhetbyt May 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt commented May 6, 2018

shobhitchittora commented May 7, 2018

trivikr left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

vsemozhetbyt commented May 7, 2018

vsemozhetbyt commented May 7, 2018

vsemozhetbyt commented May 8, 2018

shobhitchittora commented May 6, 2018 •

edited

Loading

vsemozhetbyt May 7, 2018 •

edited

Loading

vsemozhetbyt May 6, 2018 •

edited

Loading