Skip to content

docs: add missing @see tags - #16474

Merged
kgryte merged 2 commits into
developfrom
claude/cool-johnson-arnx5s
Nov 3, 2026
Merged

kgryte merged 2 commits into
developfrom
claude/cool-johnson-arnx5s

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • adds the missing @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi} tag to the exported-constant JSDoc in @stdlib/constants/float32/ln-two-pi. The tag appears in 82% (56/68) of constants/float32 packages and is copied verbatim from constants/float64/ln-two-pi.
  • adds the same tag to @stdlib/constants/float32/ln-sqrt-two-pi, copied verbatim from constants/float64/ln-sqrt-two-pi, which matches constants/float32/sqrt-two-pi and constants/float32/two-pi.

Related Issues

Does this pull request have any related issues?

None.

Reference Packages

Did the content of this pull request follow one or more existing packages? Answering is optional.

This pull request followed these packages:

  • constants/float64/ln-two-pi
  • constants/float64/ln-sqrt-two-pi

What carried over from the reference(s)?

  • The @see line, verbatim.

What differed, or what did you have to work out yourself?

  • Nothing.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Found by a majority-vote drift scan of constants/float32. The scan used a 75% threshold and three independent validation passes. JSDoc-only change. It does not affect behavior, tests, repl.txt, or TypeScript declarations.

Ten other constants/float32 packages also lack @see (half-ln-two, ln-half, ln-ten, ln-two, sqrt-half, sqrt-three, sqrt-two, num-bytes, num-exponent-bits, num-significand-bits). They were left alone on purpose: their float64 analogs carry no @see either, so there is no canonical link to copy.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of 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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code as part of an automated cross-package drift-detection run.



Generated by Claude Code

Added the `@see` reference link to the JSDoc of the exported constant (present in 56/68, or 82%, of `constants/float32` packages). The link is copied verbatim from `constants/float64/ln-two-pi`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD7BVU2tnJpH1TKaEcuT
Added the `@see` reference link to the JSDoc of the exported constant (present in 56/68, or 82%, of `constants/float32` packages). The link is copied verbatim from `constants/float64/ln-sqrt-two-pi`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD7BVU2tnJpH1TKaEcuT
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
constants/float32/ln-sqrt-two-pi $\\color{green}56/56$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}56/56$
$\\color{green}+100.00\\%$
constants/float32/ln-two-pi $\\color{green}56/56$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}56/56$
$\\color{green}+100.00\\%$

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

@kgryte
kgryte marked this pull request as ready for review November 3, 2026 23:07
@kgryte
kgryte requested a review from a team November 3, 2026 23:07
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Nov 3, 2026
@kgryte kgryte changed the title docs: add missing @see tags to constants/float32/ln-two-pi and constants/float32/ln-sqrt-two-pi docs: add missing @see tags Nov 3, 2026
@kgryte
kgryte merged commit fef28cc into develop Nov 3, 2026
34 checks passed
@kgryte
kgryte deleted the claude/cool-johnson-arnx5s branch November 3, 2026 23:08
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants