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: sync JSDoc with the actual implementation #48853

Merged
merged 1 commit into from
Jul 23, 2023
Merged

fs: sync JSDoc with the actual implementation #48853

merged 1 commit into from
Jul 23, 2023

Conversation

illusi0n7
Copy link
Contributor

JSDoc update was omitted during code implementation

Refs: #46933

@illusi0n7
fs: sync JSDoc with the actual implementation
eddf5cc 
JSDoc update was omitted during code implementation

Refs: nodejs#46933
@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 Jul 20, 2023
@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. typings and removed needs-ci PRs that need a full CI run. labels Jul 20, 2023
anonrig
anonrig reviewed Jul 21, 2023
View reviewed changes
lib/internal/fs/promises.js
@@ -255,6 +255,9 @@ class FileHandle extends EventEmitter {
/**
* @typedef {import('../webstreams/readablestream').ReadableStream
* } ReadableStream
* @param {{
* type?: string;
* }} [options]
Copy link
Member

Choose a reason for hiding this comment

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

Is this indentation correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is same as the others I think

@deokjinkim deokjinkim added the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 23, 2023
@nodejs-github-bot nodejs-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 Jul 23, 2023
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/48853
✔  Done loading data for nodejs/node/pull/48853
----------------------------------- PR info ------------------------------------
Title      fs: sync JSDoc with the actual implementation (#48853)
Author     Hyunjin Kim  (@illusi0n7, first-time contributor)
Branch     illusi0n7:dev/doc -> nodejs:main
Labels     fs, author ready, typings
Commits    1
 - fs: sync JSDoc with the actual implementation
Committers 1
 - Hyunjin Kim 
PR-URL: https://github.com/nodejs/node/pull/48853
Refs: https://github.com/nodejs/node/pull/46933
Reviewed-By: Antoine du Hamel 
Reviewed-By: Deokjin Kim 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/48853
Refs: https://github.com/nodejs/node/pull/46933
Reviewed-By: Antoine du Hamel 
Reviewed-By: Deokjin Kim 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Thu, 20 Jul 2023 14:26:27 GMT
   ✔  Approvals: 2
   ✔  - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/48853#pullrequestreview-1540155251
   ✔  - Deokjin Kim (@deokjinkim): https://github.com/nodejs/node/pull/48853#pullrequestreview-1542182649
   ✔  Last GitHub CI successful
   ✘  No Jenkins CI runs detected
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/5634524749

@aduh95 aduh95 merged commit 9c5e272 into nodejs:main Jul 23, 2023
40 checks passed
@aduh95
Copy link
Contributor

aduh95 commented Jul 23, 2023

Landed in 9c5e272, thanks for the contribution 🎉

Ceres6 pushed a commit to Ceres6/node that referenced this pull request Jul 27, 2023
@illusi0n7 @Ceres6
typings: sync JSDoc with the actual implementation
f7ed4bd 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs#46933
PR-URL: nodejs#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
pluris pushed a commit to pluris/node that referenced this pull request Aug 6, 2023
@illusi0n7
typings: sync JSDoc with the actual implementation
e444a8b 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs#46933
PR-URL: nodejs#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
pluris pushed a commit to pluris/node that referenced this pull request Aug 7, 2023
@illusi0n7
typings: sync JSDoc with the actual implementation
082a880 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs#46933
PR-URL: nodejs#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Aug 14, 2023
@illusi0n7 @Ceres6
typings: sync JSDoc with the actual implementation
e0dc180 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs#46933
PR-URL: nodejs#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Aug 14, 2023
@illusi0n7 @Ceres6
typings: sync JSDoc with the actual implementation
0bb33de 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs#46933
PR-URL: nodejs#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
UlisesGascon pushed a commit to UlisesGascon/node that referenced this pull request Aug 14, 2023
@illusi0n7 @UlisesGascon
typings: sync JSDoc with the actual implementation
094523b 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs#46933
PR-URL: nodejs#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
RafaelGSS pushed a commit that referenced this pull request Aug 15, 2023
@illusi0n7 @RafaelGSS
typings: sync JSDoc with the actual implementation
be7b511 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: #46933
PR-URL: #48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@UlisesGascon UlisesGascon mentioned this pull request Aug 15, 2023
Merged
targos pushed a commit that referenced this pull request Nov 27, 2023
@illusi0n7 @targos
typings: sync JSDoc with the actual implementation
4d70a2c 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: #46933
PR-URL: #48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@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
typings: sync JSDoc with the actual implementation
2164ac0 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs/node#46933
PR-URL: nodejs/node#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
typings: sync JSDoc with the actual implementation
3b9317d 
JSDoc comment did not match the actual implementation of
`FileHandle#readableWebStream`.

Refs: nodejs/node#46933
PR-URL: nodejs/node#48853
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anonrig anonrig anonrig left review comments

@deokjinkim deokjinkim deokjinkim approved these changes

@aduh95 aduh95 aduh95 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. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. fs Issues and PRs related to the fs subsystem / file system. typings
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@illusi0n7 @nodejs-github-bot @aduh95 @anonrig @deokjinkim