chore(*): Improve @default, @deprecated JSDoc
#5630
Merged
Conversation
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
🦋 Changeset detectedLatest commit: e3535e1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 22 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@default and @returns JSDoc usage@default, @deprecated, & @returns JSDoc
@default, @deprecated, & @returns JSDoc@default, @deprecated JSDoc
panteliselef
approved these changes
Apr 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
In this PR I'm normalizing our usage of the
@default,@deprecatedtags. I'm also modifying the Typedoc output to sometimes adjust the@returnstag output.I've checked our codebase for instances of
"Defaults to ..."and replaced it with@default <val>. This way it's captured correctly and can be added in our Typedoc output in a coherent way.Same thing with
@deprecated. Sometimes a full stop was missing at the end, sometimes the first word wasn't capitalized. I've changed the wording to have the sentence structure of "Use X instead.".I have also mostly removed sentences inside
@deprecatedthat said "This is deprecated" since it's unnecessary so say that inside the tag. I've also sometimes removed sentences like "Will be removed in next major version" because I don't think it adds much value, it's deprecated nevertheless.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change