Skip to content

docs: fix default value documentation - #14325

Merged
kgryte merged 4 commits into
developfrom
philipp/fix-commit-review-2026-08-16
Aug 16, 2026
Merged

docs: fix default value documentation#14325
kgryte merged 4 commits into
developfrom
philipp/fix-commit-review-2026-08-16

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Follow-up fixes for commits merged to develop between 2026-08-15T05:33:22-07:00 (ee85255c) and 2026-08-16T02:40:52-07:00 (066149c2).

This pull request:

  • blas/ext/base/ndarray/gdiff: Fix @returns annotation in gdiff main.js (line 48) to match ndarray family: 1004397 tagged it {Object} while sdiff/cdiff/zdiff/ddiff all use {ndarray}; changed to @returns {ndarray} output ndarray for consistency in lib/node_modules/@stdlib/blas/ext/base/ndarray/gdiff/lib/main.js.
  • stats/base/ndarray/dnanmin: Fix NaN0.0/0.0 in lib/node_modules/@stdlib/stats/base/ndarray/dnanmin/README.md (L144); NaN isn't a valid C identifier, so the example doesn't compile. Introduced in 0222395; examples/c/example.c and the snanmin README already use the correct form.
  • blas/ext/copy-within: Fixes stale documentation of the default source end index in blas/ext/copy-within: lib/main.js defaults end to N (elements along options.dim), but README.md (L57) and docs/repl.txt (L34–35), introduced in 8dc4cd2, both state N + 1, which is out-of-bounds and only harmless because of clamping. Corrects both docs to N.

Related Issues

Does this pull request have any related issues?

No.

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 36 commits merged to develop in the review window were checked for style-guide compliance (against docs/style-guides and established sibling packages) and scanned for bugs by multiple independent review passes. Checked and found clean: wrapper glue and argument order in the new blas/ext/base/ndarray diff/cunone/last-index-of-truthy families, JS/C coefficient and branch parity for math/base/special/erfinvf/erfcinvf (all 178 rational coefficients round-trip to identical float32 values; Julia fixtures pass within declared ULP tolerances), blas/ext/logspace argument normalization against its linspace template, blas/ext/copy-within semantics against Array.prototype.copyWithin, dnanmin/snanmin addon signatures and dtypes, the no-empty-lines-between-requires lint-rule fix, and the ULP test migrations. Deliberately excluded: anything requiring interpretation or judgment (e.g. mixed NaN vs 0.0/0.0 precedent in older READMEs, named-constant vs inlined-literal styles), and anything that would require changes outside the window's diff.

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

This PR was authored by Claude Code as part of a scheduled automated review of the last 24 hours of commits merged to develop; each fix was independently re-verified against the repository before being applied.


Generated by Claude Code

@stdlib-bot

stdlib-bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/copy-within $\\color{green}534/534$
$\\color{green}+0.00\\%$
$\\color{green}51/51$
$\\color{green}+0.00\\%$
$\\color{green}5/5$
$\\color{green}+0.00\\%$
$\\color{green}534/534$
$\\color{green}+0.00\\%$
stats/base/ndarray/dnanmin $\\color{green}176/176$
$\\color{green}+0.00\\%$
$\\color{green}7/7$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}176/176$
$\\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 August 16, 2026 22:48
@kgryte
kgryte requested a review from a team August 16, 2026 22:48
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Aug 16, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Aug 16, 2026
@kgryte kgryte changed the title docs: fix documentation errors in recently added packages docs: fix default value documentation Aug 16, 2026
@kgryte
kgryte merged commit 1891207 into develop Aug 16, 2026
48 checks passed
@kgryte
kgryte deleted the philipp/fix-commit-review-2026-08-16 branch August 16, 2026 23:07
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