fix: clean up JSDocs causing errors during generate-docs.mts script#1559
Draft
fix: clean up JSDocs causing errors during generate-docs.mts script#1559
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Running generate-docs.mts script reported errors due to missing JSDoc for many function overloads. This commit cleans up those cases, adding comments when they are missing or removing duplicate/redundant function declarations.
T3sT3ro
force-pushed
the
fix-jsdoc-for-generate-docs-script
branch
from
c957956 to
6ef0cbf
Compare
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
1 participant
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.
Running generate-docs.mts script reported errors due to missing JSDoc for many function overloads. This PR cleans up those cases, adding comments when they are missing or removing duplicate/redundant function declarations.
I have however some suspicions that generate-docs.mts script has not been maintained for some town now, and may be redundant already. I tried running it by itself and starting
docs:build/devtasks, but have seen no changes to the files.It is probably related to #1558 which I wanted to develop in the first place, but this is for the time being as far as I got. More help regarding workflow for documentation generations in this project is required.
It turns out that it is not so easy with partition and reduceAsync, because both of those files provide separate declaration and definition of functions. After I tried removing declarations which duplicate definitions, the typecheck task fails. After I add them back, the
generate-docs.mtsfails. I am not sure how to proceed from there.