Skip to content

docs: fix JSDoc tags in number/float16/base native variants#12821

Draft
Planeshifter wants to merge 2 commits into
developfrom
philipp/drift-number-float16-base-2026-06-11
Draft

docs: fix JSDoc tags in number/float16/base native variants#12821
Planeshifter wants to merge 2 commits into
developfrom
philipp/drift-number-float16-base-2026-06-11

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Resolves none.

Description

Two small JSDoc corrections to native variants in number/float16/base, identified by comparing each lib/native.js against its siblings within the namespace. Both deviations match a 6-of-7 (86%) majority pattern across the C-addon subset.

number/float16/base/from-word

Adds the missing @private JSDoc tag to the wrapped function in lib/native.js. Six of seven (86%) sibling lib/native.js files mark the wrapped function @privateexponent, signbit, significand, to-float32, to-float64, to-word. from-word was the lone outlier.

number/float16/base/signbit

Removes a stray leading hyphen from the @returns tag in lib/native.js. The corrected form (@returns {boolean} boolean indicating if sign bit is on or off) matches the package's own lib/main.js and 6 of 7 (86%) sibling lib/native.js files. The leading-hyphen prefix is reserved for @param tags by stdlib JSDoc convention.

Related Issues

None.

Questions

No.

Other

No.

Checklist

AI Assistance

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

This PR was written primarily by Claude Code, which compared structural and semantic features across the 12 packages in number/float16/base to identify clear majority patterns and surface outliers. Each correction was verified against the package's siblings and its own lib/main.js before being applied.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits June 11, 2026 00:11
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.
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
number/float16/base/from-word $\\color{green}195/195$
$\\color{green}+100.00\\%$
$\\color{green}18/18$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}195/195$
$\\color{green}+100.00\\%$
number/float16/base/signbit $\\color{green}178/178$
$\\color{green}+100.00\\%$
$\\color{green}7/7$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}178/178$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants