Skip to content

doc: clarify some default values in fs.md - #42892

Merged
aduh95 merged 3 commits into
nodejs:masterfrom
LiviaMedeiros:doc-fs-defaults
May 2, 2022
Merged

doc: clarify some default values in fs.md#42892
aduh95 merged 3 commits into
nodejs:masterfrom
LiviaMedeiros:doc-fs-defaults

Conversation

@LiviaMedeiros

Copy link
Copy Markdown
Member

This PR touches File system API docs:

  • Fills missing default values
  • Specifies null as allowed "type" for type in fs.symlink() and position
  • Slightly rewords fs.symlink() description to allow autodetection when type is set

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 28, 2022
Comment threaddoc/api/fs.md Outdated
@LiviaMedeiros

Copy link
Copy Markdown
MemberAuthor

76e639c adds changes in lib/fs.js, but it's jsdoc-only so I assume docIssues and PRs related to the documentations. to still be a correct subsystem choice.

@aduh95aduh95 added typings author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Apr 30, 2022
@marsonyamarsonya added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels May 1, 2022
@nodejs-github-botnodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels May 1, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/42892
✔ Done loading data for nodejs/node/pull/42892
----------------------------------- PR info ------------------------------------
Title doc: clarify some default values in fs.md (#42892)
⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch LiviaMedeiros:doc-fs-defaults -> nodejs:master
Labels doc, fs, author ready, typings, commit-queue-squash
Commits 3
- doc: clarify some default values in fs.md
- squash: declare some values as nullable in fs.js
- squash: document position in fs.readSync as optional
Committers 1
- LiviaMedeiros PR-URL: https://github.com/nodejs/node/pull/42892
Reviewed-By: Antoine du Hamel Reviewed-By: Akhil Marsonya ------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/42892
Reviewed-By: Antoine du Hamel Reviewed-By: Akhil Marsonya --------------------------------------------------------------------------------
ℹ This PR was created on Thu, 28 Apr 2022 08:25:40 GMT
✔ Approvals: 2
✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/42892#pullrequestreview-957570326
✔ - Akhil Marsonya (@marsonya): https://github.com/nodejs/node/pull/42892#pullrequestreview-958618021
✖ Last GitHub CI failed
✖ No Jenkins CI runs detected
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/2254451151

@aduh95
aduh95 merged commit 73a8a0e into nodejs:masterMay 2, 2022
@aduh95

Copy link
Copy Markdown
Contributor

Landed in 73a8a0e

RafaelGSS pushed a commit that referenced this pull request May 10, 2022
PR-URL: #42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
@RafaelGSSRafaelGSS mentioned this pull request May 10, 2022
juanarbol pushed a commit that referenced this pull request May 31, 2022
PR-URL: #42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
PR-URL: #42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
targos pushed a commit that referenced this pull request Jul 12, 2022
PR-URL: #42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
PR-URL: #42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
@targostargos mentioned this pull request Aug 3, 2022
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
PR-URL: nodejs/node#42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-failedAn error occurred while landing this pull request using GitHub Actions.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.typings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@LiviaMedeiros@nodejs-github-bot@aduh95@marsonya