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

update fs doc for filter #49289

Merged
merged 2 commits into from Aug 26, 2023
Merged

update fs doc for filter #49289

merged 2 commits into from Aug 26, 2023

Conversation

shubham9411
Copy link
Contributor

@shubham9411 shubham9411 commented Aug 22, 2023 •
edited by aduh95

Updating doc for fs.cp, fsPromises.cp and fs.cpSync.

Added the caveat that filter will be applied to both files and dirs.

Fixes: #49092

@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 Aug 22, 2023
@shubham9411 shubham9411 mentioned this pull request Aug 22, 2023
Closed
tniessen
tniessen reviewed Aug 22, 2023
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

This seems extremely long and verbose for a rather simple statement. The documentation already says that the function will be applied to files and directories.

doc/api/fs.md Outdated Show resolved Hide resolved
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 23, 2023
tniessen
tniessen approved these changes Aug 23, 2023
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

Nit: commit message does not adhere to the commit message guidelines

@LiviaMedeiros
Copy link
Contributor

The commit message guidelines suggest that it should start with an imperative verb, so maybe something like

doc: update doc for fs.cp, fsPromises.cp and fs.cpSync

or

doc: update options.filter description for fs.cp

Would be slightly better.

@shubham9411
Copy link
Contributor Author

@LiviaMedeiros yes, I had updated first commit to
doc: update doc for fs.cp, fsPromises.cp and fs.cpSync
😄

@aduh95 aduh95 merged commit 4178683 into nodejs:main Aug 26, 2023
14 checks passed
@aduh95
Copy link
Contributor

aduh95 commented Aug 26, 2023

Landed in 4178683, thanks for the contribution :)

UlisesGascon pushed a commit that referenced this pull request Sep 10, 2023
@shubham9411 @UlisesGascon
doc: update options.filter description for fs.cp
7c0cd2f 
PR-URL: #49289
Fixes: #49092
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
@UlisesGascon UlisesGascon mentioned this pull request Sep 10, 2023
Merged
alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023
@shubham9411 @alexfernandez
doc: update options.filter description for fs.cp
06b92ec 
PR-URL: nodejs#49289
Fixes: nodejs#49092
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
targos pushed a commit that referenced this pull request Nov 27, 2023
@shubham9411 @targos
doc: update options.filter description for fs.cp
0dda724 
PR-URL: #49289
Fixes: #49092
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
@targos targos mentioned this pull request Nov 28, 2023
Merged
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
doc: update options.filter description for fs.cp
7e5adf2 
PR-URL: nodejs/node#49289
Fixes: nodejs/node#49092
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
doc: update options.filter description for fs.cp
4ea512a 
PR-URL: nodejs/node#49289
Fixes: nodejs/node#49092
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@tniessen tniessen tniessen approved these changes

@aymen94 aymen94 aymen94 approved these changes

@aduh95 aduh95 aduh95 approved these changes

@LiviaMedeiros LiviaMedeiros LiviaMedeiros 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. 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.

"Experimental" fs.cp(), fs.cpSync(), fsPromises.cp() methods don't handle recursion when there is a filter
7 participants
@shubham9411 @LiviaMedeiros @aduh95 @lpinca @tniessen @aymen94 @nodejs-github-bot