Skip to content

docs: fix description - #15322

Merged
kgryte merged 6 commits into
developfrom
philipp/fix-commit-review-2026-09-18
Sep 28, 2026
Merged

kgryte merged 6 commits into
developfrom
philipp/fix-commit-review-2026-09-18

Conversation

@Planeshifter

@Planeshifter Planeshifter commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Follow-up fix for commits merged to develop between 2026-09-17T23:23:38-07:00 (625cd5d) and 2026-09-17T23:55:31-07:00 (51a1812).

This pull request:

  • ndarray/ones-like: Fixes a copy-paste from 51a1812: the Float16Options overload said "single-precision" — should be "half-precision", matching what zeros-like already got right. One-line fix in docs/types/index.d.ts.

Related Issues

Does this pull request have any related issues?

No related issues.

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.

Validation. All 20 commits merged to develop in the window were reviewed for style-guide compliance (against docs/style-guides and established reference packages) and scanned for bugs by independent reviewers; only findings corroborated by multiple reviewers and re-verified against the diffs were retained.

Scope note. This PR originally also loosened the ULP tolerances in stats/base/dists/cauchy/cdf and stats/base/dists/lognormal/mode test.native.js on the premise that the native suites are not exercised in PR CI. That premise was wrong — CI compiles the add-ons and runs the native tests, so the migrated bounds were already validated against native output — and both commits were reverted (de061f1, a907bd3) following review discussion. The net diff is the one-line ndarray/ones-like docs fix.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance.

This PR was written by Claude Code as part of an automated review of commits recently merged to develop; findings were cross-checked by multiple independent review passes and verified against the diffs before fixes were authored.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NJCXZyRqsVkbrugTvVu7LY

The migration to ULP-based assertions copied the ULP bounds derived
from the JavaScript test suite (32/128) into `test.native.js`, whose
original tolerances were deliberately looser (750 eps and 8200 eps)
and documented a fixture case for which the native implementation
differs from the expected value by approximately 13764 ULPs. This
restores equivalent bounds and the explanatory note.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NJCXZyRqsVkbrugTvVu7LY
The migration to ULP-based assertions replaced the native test's
deliberately looser tolerance of 18 eps with an exact-equality
assertion (0 ULPs) copied from the JavaScript test suite, whose
original tolerance was only 1 eps. This restores an equivalent bound
of 36 ULPs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NJCXZyRqsVkbrugTvVu7LY
The `Float16Options` overload's description was copied from the
`float32` overload and read "single-precision" instead of
"half-precision".

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NJCXZyRqsVkbrugTvVu7LY
@stdlib-bot

stdlib-bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/ones-like $\\color{red}217/219$
$\\color{green}+0.00\\%$
$\\color{red}35/36$
$\\color{green}+0.00\\%$
$\\color{green}1/1$
$\\color{green}+0.00\\%$
$\\color{red}217/219$
$\\color{green}+0.00\\%$

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

@kgryte
kgryte marked this pull request as ready for review September 28, 2026 05:45
@kgryte
kgryte requested a review from a team September 28, 2026 05:45
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Sep 28, 2026
Comment thread lib/node_modules/@stdlib/stats/base/dists/lognormal/mode/test/test.native.js Outdated
…rmal/mode`"

This reverts commit 031bb4e. The premise
was incorrect: PR CI compiles the native add-ons and runs the native test
suites, so the migrated 0 ULP bound was validated against actual native
output and the looser bound is unnecessary.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NJCXZyRqsVkbrugTvVu7LY
…hy/cdf`"

This reverts commit 461873c. The premise
was incorrect: PR CI compiles the native add-ons and runs the native test
suites, so the migrated 32/128 ULP bounds were validated against actual
native output and the documented outlier in the removed note no longer
reflects current native behavior.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NJCXZyRqsVkbrugTvVu7LY
@Planeshifter Planeshifter changed the title fix: restore native test tolerances and fix overload description docs: fix overload description in ndarray/ones-like Sep 28, 2026
@kgryte kgryte changed the title docs: fix overload description in ndarray/ones-like docs: fix description Sep 28, 2026
@kgryte
kgryte merged commit 0fc57ae into develop Sep 28, 2026
16 checks passed
@kgryte
kgryte deleted the philipp/fix-commit-review-2026-09-18 branch September 28, 2026 07:48
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Sep 28, 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