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

fs: update param in jsdoc for readdir #50448

Merged
merged 1 commit into from Oct 30, 2023
Merged

fs: update param in jsdoc for readdir #50448

merged 1 commit into from Oct 30, 2023

Conversation

pluris
Copy link
Contributor

@pluris pluris commented Oct 28, 2023 •
edited

Fixed inconsistencies between jsdoc and api documentation.

  • recursive is missing
  • Dirent is written as Direct

node/doc/api/fs.md

Lines 3672 to 3681 in 4c3dde9

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* `withFileTypes` {boolean} **Default:** `false`
* `recursive` {boolean} If `true`, reads the contents of a directory
recursively. In recursive mode, it will list all files, sub files and
directories. **Default:** `false`.
* `callback` {Function}
* `err` {Error}
* `files` {string\[]|Buffer\[]|fs.Dirent\[]}

@nodejs-github-bot nodejs-github-bot added fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run. labels Oct 28, 2023
@anonrig anonrig added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Oct 28, 2023
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 28, 2023
@nodejs-github-bot
Copy link
Collaborator

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

@github-actions github-actions bot mentioned this pull request Oct 29, 2023
Open
21 tasks
@nodejs-github-bot
Copy link
Collaborator

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

@deokjinkim deokjinkim added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 29, 2023
@github-actions github-actions bot mentioned this pull request Oct 30, 2023
Open
25 tasks
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 30, 2023
@nodejs-github-bot nodejs-github-bot merged commit 63494a9 into nodejs:main Oct 30, 2023
63 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 63494a9

This was referenced Oct 31, 2023
Open
Open
alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023
@pluris @alexfernandez
fs: update param in jsdoc for readdir
9de91ec 
PR-URL: nodejs#50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@pluris pluris deleted the fs/jsdoc branch November 8, 2023 02:23
targos pushed a commit that referenced this pull request Nov 11, 2023
@pluris @targos
fs: update param in jsdoc for readdir
b5308be 
PR-URL: #50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@targos targos mentioned this pull request Nov 12, 2023
Merged
targos pushed a commit that referenced this pull request Nov 14, 2023
@pluris @targos
fs: update param in jsdoc for readdir
44f19ce 
PR-URL: #50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
UlisesGascon pushed a commit that referenced this pull request Dec 11, 2023
@pluris @UlisesGascon
fs: update param in jsdoc for readdir
d1b6bd6 
PR-URL: #50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@UlisesGascon UlisesGascon mentioned this pull request Dec 12, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@lpinca lpinca lpinca approved these changes

@anonrig anonrig anonrig approved these changes

@deokjinkim deokjinkim deokjinkim 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. fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@pluris @nodejs-github-bot @jasnell @lpinca @anonrig @deokjinkim