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

Add example to fs docs #28365

Closed
wants to merge 4 commits into from
Closed

Add example to fs docs #28365

wants to merge 4 commits into from

Conversation

roadev
Copy link
Contributor

@roadev roadev commented Jun 21, 2019

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Jun 21, 2019
@jasnell jasnell added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Jun 23, 2019
Trott
Trott requested changes Jun 24, 2019
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome @roadev and thanks for the pull request! I'm not sure this example demonstrates anything to the user about file modes, which is what this section of the documentation is about. Perhaps it should be moved to the parent section about fs.chmod()? The reader shouldn't have to scroll through all the file-mode stuff to get an example of fs.chmod() since they may already know all about file modes....

@roadev roadev force-pushed the add_example_to_fs_docs branch from d33dcef to e07c335 Compare June 25, 2019 18:57
@roadev
Copy link
Contributor Author

roadev commented Jun 25, 2019

Welcome @roadev and thanks for the pull request! I'm not sure this example demonstrates anything to the user about file modes, which is what this section of the documentation is about. Perhaps it should be moved to the parent section about fs.chmod()? The reader shouldn't have to scroll through all the file-mode stuff to get an example of fs.chmod() since they may already know all about file modes....

You're right @Trott !
I've pushed the changes. Thanks!

Trott
Trott reviewed Jun 26, 2019
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
@roadev @Trott
fs: fix second argument in chmod example
4e6694e 
Co-Authored-By: Rich Trott <rtrott@gmail.com>
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 26, 2019
@Trott
Copy link
Member

Trott commented Jun 26, 2019

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3719/

@addaleax
Copy link
Member

addaleax commented Jul 3, 2019 •
edited
Loading

Landed in 41fad84

Thanks for the contribution! 🎉

(If you're interested in other possible contributions to Node.js but don't have a good idea of where to start looking, some ideas are posted at https://www.nodetodo.org/next-steps/.)

@addaleax addaleax closed this Jul 3, 2019
addaleax pushed a commit that referenced this pull request Jul 3, 2019
@roadev @addaleax
doc: add example for chmod in fs.md
41fad84 
PR-URL: #28365
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
targos pushed a commit that referenced this pull request Jul 20, 2019
@roadev @targos
doc: add example for chmod in fs.md
e83b256 
PR-URL: #28365
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
This was referenced Jul 23, 2019
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@addaleax addaleax addaleax approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@roadev @Trott @addaleax @jasnell @nodejs-github-bot