docs: clean-up

[Planeshifter]

Description

What is the purpose of this pull request?

This pull request propagates documentation fixes merged to develop between 2026-10-11 and 2026-10-12 to sibling packages.

• Propagates d06f1b1 ("docs: fix parameter names"). The C JSDoc @param names did not match the function signatures, so this renames them and realigns the description columns where a name changed length.
  • math/base/special/ellipe (x → m)
  • math/base/special/ellipk (x → m)
  • math/base/special/gammainc (initialValue → initValue in lowerGammaSeries)
  • math/base/special/logit (x → p)
  • math/base/special/logitf (x → p)
  • random/base/shared (state → vstate, matching shared.h)
  • stats/base/dists/uniform/entropy (n, p → a, b)
  • stats/base/dists/uniform/kurtosis (n, p → a, b)
  • stats/base/dists/uniform/stdev (n, p → a, b)
• Propagates 3bf4053 ("docs: update example"). Several TypeScript declaration @example blocks declared the same variable twice with var, so this removes the redundant var (39 lines in 29 files):
  • array, array/datespace, array/dtype
  • assert, assert/is-method
  • complex, complex/dtype
  • math/base/special
  • ndarray/base, ndarray/base/buffer-dtype
  • stats/base/dists/betaprime (namespace, cdf, logcdf, logpdf, pdf, quantile)
  • stats/base/dists/chisquare (namespace, cdf)
  • stats/base/dists/gamma (namespace, logcdf, logpdf)
  • stats/base/dists/halfnormal/logpdf
  • stats/base/dists/levy (namespace, logcdf)
  • stats/base/dists/signrank (namespace, cdf, pdf)
  • wasm/base, wasm/base/array2dtype

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

• Search scope. Every src/main.c under lib/node_modules/@stdlib was compared by script: each JSDoc @param list against its function signature. Every docs/types/*.d.ts was scanned for a var declared twice in one @example. For the other candidate commits, the scans turned up no remaining sites:
  • bf33e96: ## Notes used inside a C API section
  • 2861fe4: missing * * * before <section class="c">
• Review. Two validators reviewed every site independently, an adaptation pass produced the per-site patches, and a style-consistency pass checked alignment and prefixes against the surrounding code.
• Excluded sites.
  • In 29 utils/async/* @example blocks, the earlier var opts is inside a nested callback, so it is in a different scope and not a redeclaration. Removing var there would create an undeclared global.
  • Two packages were dropped because CI lints every changed file in full, and these files already fail lint for reasons unrelated to this fix:
    • array/int64 and array/uint64: their declaration files have no-unused-vars errors.
    • math/base/special/minmax, minmaxf and minmaxn: the assign examples document a return value the code does not produce, which fails stdlib/tsdoc-declarations-doctest.
• Not propagated. ba2b826 (x.shape → getShape( x )) was not propagated because applying it needs per-site judgement.

Checklist

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

• Read, understood, and followed the contributing guidelines.

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 fix-propagation routine.

---

🤖 Generated with Claude Code

https://claude.ai/code/session_01BJJr7UoajiduviP1Fk7sm9

[Planeshifter]

Run affected tests is failing in blas/ext/to-sorted/test/test.assign.js, in the test "the function throws an error if provided a sortOrder argument which is not broadcast-compatible". The test passes a sortOrder ndarray of shape [4], [2,2,2] or [0] with x of shape [2,2]. It expects assign to throw, but assign returns normally, so 6 assertions fail.

The failure does not come from this PR. The PR only touches JSDoc comments in .d.ts and src/main.c files, and none of those are loaded at runtime. I reproduced the same 6 failures locally on an unmodified checkout of blas/ext/to-sorted, so the test is also red on develop. It only shows up here because the namespace .d.ts edits (array, ndarray/base, ...) widen the set of affected packages that CI tests. assign hands sortOrder validation to blas/ext/sort, so the missing broadcast check is probably there. No fix PR exists yet. Fixing it is out of scope for this PR, so I'm leaving this PR as is.

The failure is deterministic, so I have not re-run the check.

---

Generated by Claude Code

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
array	$\\color{red}66018/90762$ $\\color{green}+72.74\\%$	$\\color{red}982/1039$ $\\color{green}+94.51\\%$	$\\color{red}43/988$ $\\color{green}+4.35\\%$	$\\color{red}66018/90762$ $\\color{green}+72.74\\%$
array/datespace	$\\color{green}236/236$ $\\color{green}+100.00\\%$	$\\color{green}40/40$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}236/236$ $\\color{green}+100.00\\%$
array/dtype	$\\color{green}267/267$ $\\color{green}+100.00\\%$	$\\color{green}13/13$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}267/267$ $\\color{green}+100.00\\%$
assert	$\\color{red}46060/49548$ $\\color{green}+92.96\\%$	$\\color{red}889/1017$ $\\color{green}+87.41\\%$	$\\color{red}63/427$ $\\color{green}+14.75\\%$	$\\color{red}46060/49548$ $\\color{green}+92.96\\%$
assert/is-method	$\\color{green}104/104$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}104/104$ $\\color{green}+100.00\\%$
complex	$\\color{red}8265/9304$ $\\color{green}+88.83\\%$	$\\color{red}158/159$ $\\color{green}+99.37\\%$	$\\color{red}2/87$ $\\color{green}+2.30\\%$	$\\color{red}8265/9304$ $\\color{green}+88.83\\%$
complex/dtype	$\\color{green}217/217$ $\\color{green}+100.00\\%$	$\\color{green}10/10$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}217/217$ $\\color{green}+100.00\\%$
math/base/special	$\\color{red}67367/83434$ $\\color{green}+80.74\\%$	$\\color{red}1075/1121$ $\\color{green}+95.90\\%$	$\\color{red}12/806$ $\\color{green}+1.49\\%$	$\\color{red}67367/83434$ $\\color{green}+80.74\\%$
math/base/special/ellipe	$\\color{red}833/857$ $\\color{green}+97.20\\%$	$\\color{red}59/71$ $\\color{green}+83.10\\%$	$\\color{green}14/14$ $\\color{green}+100.00\\%$	$\\color{red}833/857$ $\\color{green}+97.20\\%$
math/base/special/ellipk	$\\color{green}869/869$ $\\color{green}+100.00\\%$	$\\color{green}83/83$ $\\color{green}+100.00\\%$	$\\color{green}14/14$ $\\color{green}+100.00\\%$	$\\color{green}869/869$ $\\color{green}+100.00\\%$
math/base/special/gammainc	$\\color{red}1755/1978$ $\\color{green}+88.73\\%$	$\\color{red}124/155$ $\\color{green}+80.00\\%$	$\\color{red}21/27$ $\\color{green}+77.78\\%$	$\\color{red}1755/1978$ $\\color{green}+88.73\\%$
math/base/special/logit	$\\color{green}191/191$ $\\color{green}+100.00\\%$	$\\color{green}13/13$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}191/191$ $\\color{green}+100.00\\%$
math/base/special/logitf	$\\color{green}192/192$ $\\color{green}+100.00\\%$	$\\color{green}13/13$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}192/192$ $\\color{green}+100.00\\%$
ndarray/base	$\\color{red}178087/348918$ $\\color{green}+51.04\\%$	$\\color{red}1938/1967$ $\\color{green}+98.53\\%$	$\\color{red}20/1727$ $\\color{green}+1.16\\%$	$\\color{red}178087/348918$ $\\color{green}+51.04\\%$
ndarray/base/buffer-dtype	$\\color{red}285/288$ $\\color{green}+98.96\\%$	$\\color{green}17/17$ $\\color{green}+100.00\\%$	$\\color{red}1/2$ $\\color{green}+50.00\\%$	$\\color{red}285/288$ $\\color{green}+98.96\\%$
random/base/shared	$\\color{green}100/100$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}0/0$ $\\color{green}+100.00\\%$	$\\color{green}100/100$ $\\color{green}+100.00\\%$
stats/base/dists/betaprime	$\\color{red}2171/2576$ $\\color{green}+84.28\\%$	$\\color{green}30/30$ $\\color{green}+100.00\\%$	$\\color{red}0/28$ $\\color{green}+0.00\\%$	$\\color{red}2171/2576$ $\\color{green}+84.28\\%$
stats/base/dists/betaprime/cdf	$\\color{green}333/333$ $\\color{green}+100.00\\%$	$\\color{green}29/29$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}333/333$ $\\color{green}+100.00\\%$
stats/base/dists/betaprime/logcdf	$\\color{green}335/335$ $\\color{green}+100.00\\%$	$\\color{green}29/29$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}335/335$ $\\color{green}+100.00\\%$
stats/base/dists/betaprime/logpdf	$\\color{green}342/342$ $\\color{green}+100.00\\%$	$\\color{green}25/25$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}342/342$ $\\color{green}+100.00\\%$
stats/base/dists/betaprime/pdf	$\\color{green}321/321$ $\\color{green}+100.00\\%$	$\\color{green}21/21$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}321/321$ $\\color{green}+100.00\\%$
stats/base/dists/betaprime/quantile	$\\color{green}314/314$ $\\color{green}+100.00\\%$	$\\color{green}25/25$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}314/314$ $\\color{green}+100.00\\%$
stats/base/dists/chisquare	$\\color{red}2148/2302$ $\\color{green}+93.31\\%$	$\\color{green}34/34$ $\\color{green}+100.00\\%$	$\\color{red}0/31$ $\\color{green}+0.00\\%$	$\\color{red}2148/2302$ $\\color{green}+93.31\\%$
stats/base/dists/chisquare/cdf	$\\color{green}241/241$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}241/241$ $\\color{green}+100.00\\%$
stats/base/dists/gamma	$\\color{red}2736/3383$ $\\color{green}+80.88\\%$	$\\color{green}39/39$ $\\color{green}+100.00\\%$	$\\color{red}0/37$ $\\color{green}+0.00\\%$	$\\color{red}2736/3383$ $\\color{green}+80.88\\%$
stats/base/dists/gamma/logcdf	$\\color{green}289/289$ $\\color{green}+100.00\\%$	$\\color{green}19/19$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}289/289$ $\\color{green}+100.00\\%$
stats/base/dists/gamma/logpdf	$\\color{red}494/546$ $\\color{green}+90.48\\%$	$\\color{red}40/49$ $\\color{green}+81.63\\%$	$\\color{green}6/6$ $\\color{green}+100.00\\%$	$\\color{red}494/546$ $\\color{green}+90.48\\%$
stats/base/dists/halfnormal/logpdf	$\\color{red}305/307$ $\\color{green}+99.35\\%$	$\\color{red}19/20$ $\\color{green}+95.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{red}305/307$ $\\color{green}+99.35\\%$
stats/base/dists/levy	$\\color{red}2029/2389$ $\\color{green}+84.93\\%$	$\\color{green}30/30$ $\\color{green}+100.00\\%$	$\\color{red}0/28$ $\\color{green}+0.00\\%$	$\\color{red}2029/2389$ $\\color{green}+84.93\\%$
stats/base/dists/levy/logcdf	$\\color{green}311/311$ $\\color{green}+100.00\\%$	$\\color{green}23/23$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}311/311$ $\\color{green}+100.00\\%$
stats/base/dists/signrank	$\\color{red}750/979$ $\\color{green}+76.61\\%$	$\\color{green}13/13$ $\\color{green}+100.00\\%$	$\\color{red}0/9$ $\\color{green}+0.00\\%$	$\\color{red}750/979$ $\\color{green}+76.61\\%$
stats/base/dists/signrank/cdf	$\\color{green}382/382$ $\\color{green}+100.00\\%$	$\\color{green}40/40$ $\\color{green}+100.00\\%$	$\\color{green}5/5$ $\\color{green}+100.00\\%$	$\\color{green}382/382$ $\\color{green}+100.00\\%$
stats/base/dists/signrank/pdf	$\\color{red}359/361$ $\\color{green}+99.45\\%$	$\\color{red}36/37$ $\\color{green}+97.30\\%$	$\\color{green}5/5$ $\\color{green}+100.00\\%$	$\\color{red}359/361$ $\\color{green}+99.45\\%$
stats/base/dists/uniform/entropy	$\\color{green}184/184$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}184/184$ $\\color{green}+100.00\\%$
stats/base/dists/uniform/kurtosis	$\\color{green}186/186$ $\\color{green}+100.00\\%$	$\\color{green}9/9$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}186/186$ $\\color{green}+100.00\\%$
stats/base/dists/uniform/stdev	$\\color{green}184/184$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}184/184$ $\\color{green}+100.00\\%$
wasm/base	$\\color{red}601/670$ $\\color{green}+89.70\\%$	$\\color{green}9/9$ $\\color{green}+100.00\\%$	$\\color{red}0/4$ $\\color{green}+0.00\\%$	$\\color{red}601/670$ $\\color{green}+89.70\\%$
wasm/base/array2dtype	$\\color{green}104/104$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}104/104$ $\\color{green}+100.00\\%$

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

[kgryte]

As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge.