-
-
Notifications
You must be signed in to change notification settings - Fork 33.9k
doc: add File modes cross-references in fs methods #60286
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
base: main
Are you sure you want to change the base?
Conversation
|
Friendly ping @nodejs/documentation 👋 Would appreciate any feedback on this when you have a chance! Happy to make any changes if needed. Thanks for your time! |
|
Bumping this after 3 weeks - would really appreciate any feedback! 🙂 |
332e39c to
5cd21cf
Compare
Adds links to the File modes section from fsPromises.open(), fsPromises.mkdir(), and fs.mkdir() to improve discoverability of file permission documentation.
5cd21cf to
749745f
Compare
|
Thank you @UlisesGascon for the review and approval! Really appreciate the help throughout this process! 🙏 |
Commit Queue failed- Loading data for nodejs/node/pull/60286 ✔ Done loading data for nodejs/node/pull/60286 ----------------------------------- PR info ------------------------------------ Title doc: add File modes cross-references in fs methods (#60286) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch Mohit-Raj-Saxena:fix-fs-docs -> nodejs:main Labels doc, fs, author ready Commits 2 - doc: add File modes cross-references in fs methods - doc: fix link reference ordering for File modes Committers 1 - Babu-Bhai-No-1 <rajmohitsaxena@gmail.com> PR-URL: https://github.com/nodejs/node/pull/60286 Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/60286 Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> -------------------------------------------------------------------------------- ℹ This PR was created on Thu, 16 Oct 2025 21:42:59 GMT ✔ Approvals: 1 ✔ - Ulises Gascón (@UlisesGascon): https://github.com/nodejs/node/pull/60286#pullrequestreview-3470011236 ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/main up to date... From https://github.com/nodejs/node * branch main -> FETCH_HEAD ✔ origin/main is now up-to-date - Downloading patch for 60286 From https://github.com/nodejs/node * branch refs/pull/60286/merge -> FETCH_HEAD ✔ Fetched commits as 189a0a71de7f..d7d155c95d80 -------------------------------------------------------------------------------- [main fa690305e3] doc: add File modes cross-references in fs methods Author: Babu-Bhai-No-1 <rajmohitsaxena@gmail.com> Date: Fri Oct 17 03:03:05 2025 +0530 1 file changed, 7 insertions(+), 3 deletions(-) [main c33a8ba0c4] doc: fix link reference ordering for File modes Author: Babu-Bhai-No-1 <rajmohitsaxena@gmail.com> Date: Sun Nov 9 12:48:08 2025 +0530 1 file changed, 1 insertion(+), 1 deletion(-) ✔ Patches applied There are 2 commits in the PR. Attempting autorebase. (node:2266) [DEP0190] DeprecationWarning: Passing args to a child process with shell option true can lead to security vulnerabilities, as the arguments are not escaped, only concatenated. (Use `node --trace-deprecation ...` to show where the warning was created) Rebasing (2/4) Executing: git node land --amend --yes --------------------------------- New Message ---------------------------------- doc: add File modes cross-references in fs methodshttps://github.com/nodejs/node/actions/runs/19611966069 |
|
[Uploading 274275662 |
Adds cross-references to the File modes section from methods that use the
modeparameter, improving discoverability of file permission documentation.Changes
[File modes][]links infsPromises.open(),fsPromises.mkdir(), andfs.mkdir()parameter documentation[File modes]: #file-modeslink referenceMotivation
Previously, developers using methods with
modeparameters (like0o666,0o777) had to manually search for the File modes table. This change provides direct links to the relevant documentation.Fixes #60280