doc: add missing return types in fs.md - #65307
Open
chasetonco wants to merge 1 commit into
Open
Conversation
Three entries in the fs documentation described their return value only in
prose, or not at all, so doc-kit could not parse a return type and fell back
to `void`:
* `filehandle[Symbol.asyncDispose]()` and `dir[Symbol.asyncDispose]()` both
return a promise, matching the existing `Returns: {Promise}` annotations on
other async dispose methods.
* `new fs.Utf8Stream([options])` is a constructor and returns an instance of
the class.
Verified at runtime and by rendering the page locally with doc-kit.
Refs: nodejs/doc-kit#953
Signed-off-by: Chxxeton <43923165+Chxxeton@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three entries in the
fsdocumentation described their return value only in prose, or not at all, so the documentation tooling could not parse a return type and fell back tovoid:filehandle[Symbol.asyncDispose]()anddir[Symbol.asyncDispose]()both return a promise. This matches the existingReturns: {Promise}annotations on other async dispose methods, such asheapProfileHandle[Symbol.asyncDispose]()inv8.md.new fs.Utf8Stream([options])is a constructor and returns an instance of the class, annotated the same way as thefs.ReadStreamandfs.WriteStreamconstructors in this file.No prose was changed; only the structured
Returns:lines were added.Verified by calling each function on a local build and by rendering
fs.mdlocally, which now showsPromise,Promiseandfs.Utf8Streaminstead ofvoid.Refs: nodejs/doc-kit#953