docs(useCounter): mark options as optional - #551
Open
theluckystrike wants to merge 1 commit into
Open
theluckystrike wants to merge 1 commit into
theluckystrike wants to merge 1 commit into
Conversation
useCounter defaults options to {}, but the JSDoc listed it as a
required parameter, so the API pages and the agent skill showed
`options: UseCounterOptions` with a required badge.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: a4c64ce The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #551 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 69 69
Lines 2280 2280
Branches 737 737
=========================================
Hits 2280 2280 🚀 New features to boost your workflow:
|
This branch has not been deployed
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
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.
Overview
useCounterdefaults its second argument to{}:The JSDoc listed
optionswithout brackets, so the generated API page showsoptions: UseCounterOptionswith a required badge. The spec already callsuseCounter()with no arguments.This PR changes the tag to
[options], regenerates the English page withyarn docs:gen useCounterand the skill reference withyarn skill:gen, and makes the same two edits by hand in the ko, ja, zh-Hans and es pages. It also adds a patch changeset, like #509 did for its JSDoc changes.Only
useCounteris touched.useMaphas the same issue withinitialValue, but #532 is changing that file, so I left it out.Checklist
yarn run fixto format and lint the code and docs? (prettier check passes on the changed files)yarn run test:coverageto make sure there is no uncovered line? (no code change)yarn test:docsandyarn test:skillpass locally.