docs: fix JSDoc tags in number/float16/base native variants#12821
Draft
Planeshifter wants to merge 2 commits into
Draft
docs: fix JSDoc tags in number/float16/base native variants#12821Planeshifter wants to merge 2 commits into
number/float16/base native variants#12821Planeshifter wants to merge 2 commits into
Conversation
Adds the `@private` JSDoc tag to the native variant, matching the convention used by 6 of 7 (86%) sibling C-addon packages in `number/float16/base` whose `lib/native.js` marks the wrapped function as private (exponent, signbit, significand, to-float32, to-float64, to-word).
…/signbit`
Removes a spurious leading hyphen after the type in the native
variant's `@returns` JSDoc tag. The corrected form (`@returns {type}
description`) matches the package's own `lib/main.js` as well as 6 of
7 (86%) sibling `lib/native.js` files in the namespace; the hyphen
prefix is reserved for `@param` tags by stdlib JSDoc convention.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
7 tasks
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.
Resolves none.
Description
Two small JSDoc corrections to native variants in
number/float16/base, identified by comparing eachlib/native.jsagainst its siblings within the namespace. Both deviations match a 6-of-7 (86%) majority pattern across the C-addon subset.number/float16/base/from-wordAdds the missing
@privateJSDoc tag to the wrapped function inlib/native.js. Six of seven (86%) siblinglib/native.jsfiles mark the wrapped function@private—exponent,signbit,significand,to-float32,to-float64,to-word.from-wordwas the lone outlier.number/float16/base/signbitRemoves a stray leading hyphen from the
@returnstag inlib/native.js. The corrected form (@returns {boolean} boolean indicating if sign bit is on or off) matches the package's ownlib/main.jsand 6 of 7 (86%) siblinglib/native.jsfiles. The leading-hyphen prefix is reserved for@paramtags by stdlib JSDoc convention.Related Issues
None.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code, which compared structural and semantic features across the 12 packages in
number/float16/baseto identify clear majority patterns and surface outliers. Each correction was verified against the package's siblings and its ownlib/main.jsbefore being applied.@stdlib-js/reviewers
Generated by Claude Code