Skip to content

docs: propagate description and example fixes to sibling packages#13059

Draft
Planeshifter wants to merge 2 commits into
developfrom
philipp/fix-propagation-2026-06-22
Draft

docs: propagate description and example fixes to sibling packages#13059
Planeshifter wants to merge 2 commits into
developfrom
philipp/fix-propagation-2026-06-22

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between 2026-06-21 18:18 UTC and 2026-06-22 08:23 UTC to sibling packages.

docs: propagate one-dimensional ndarray qualifier to {d,s}axpby

Source: d826990 ("docs: update function descriptions"). Adds the "one-dimensional" qualifier to the brief description in lib/index.js, lib/main.js, and package.json for two sibling packages whose READMEs, TypeScript declarations, REPL help, and JSDoc ## Notes sections already document them as operating on one-dimensional ndarrays. Mirrors the dxpy/sxpy precedent exactly.

  • blas/ext/base/ndarray/daxpby
  • blas/ext/base/ndarray/saxpby

chore: propagate FLOAT32_-prefixed example variable to constants/float32/e

Source: 4154fdc ("chore: update examples and add keyword"). Renames the JSDoc @example variable from E to FLOAT32_E in lib/index.js, aligning the package with the FLOAT32_-prefixed naming convention used by every other constants/float32/* package.

  • constants/float32/e

Related Issues

No.

Questions

No.

Other

Validation

  • Pattern search scoped to siblings under the same namespace as each source commit (blas/ext/base/ndarray/* and constants/float32/*).
  • Two independent opus validation passes confirmed the defect at each target site and the absence of contradicting context (no AUTOGENERATED markers; READMEs/TypeScript types/REPL help already use the one-dimensional wording for the {d,s}axpby targets; every other constants/float32/* package uses the FLOAT32_ prefix).
  • Style-consistency check confirms each patch mirrors the exact wording used in the source commit.

Deliberately excluded

  • C compiler-warning fix (dadabba, fa820b3) — all stats/base/ndarray/*/src/addon.c files already use the const-qualified pointer-list pattern; no sites remain.
  • BLAS *xsy README copy fix (f87196f) — sibling cxsy, gxsy, sxsy, zxsy READMEs already use the corrected "subtract" wording.
  • PDFPMF typo fix (83e6c53) — no remaining "probability mass function (PDF)" or "probability density function (PMF)" instances under stats/ or math/.
  • "number" keyword + // MAIN // heading additions (68d7a66) — all number/float64/base/* packages already have the keyword and section heading.
  • Slice internal-variable rename (71f4c29) — stylistic refactor, not a defect; no objective criterion to flag other call sites.
  • array/base/reject typed-array return annotation fix (794978c, ed5107b) — limited to the originating package; no sibling exhibits the same incorrect type annotation.
  • The same EFLOAT32_E rename in constants/float32/e/README.md (lines 30, 55) was held out — the source commit narrowed scope to the JSDoc @example block in lib/index.js. A follow-up can sweep the README if desired.

Checklist

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 an automated routine that scans recent develop commits for fix patterns and propagates equivalent fixes to sibling packages. Each target site was independently validated by two opus passes before any patch was applied.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits June 22, 2026 13:13
…xpby`

Propagates fix from d826990 ("docs: update function descriptions") to
sibling packages with the same one-dimensional ndarray contract. Both
functions are documented as operating on one-dimensional ndarrays in
their READMEs, TypeScript declarations, REPL help, and JSDoc `## Notes`
sections; the brief descriptions are updated to match.
Propagates fix from 4154fdc ("chore: update examples and add keyword")
to align the JSDoc example with the FLOAT32_-prefixed naming convention
used by every other `constants/float32/*` package.
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/ndarray/daxpby $\\color{green}136/136$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}136/136$
$\\color{green}+100.00\\%$
blas/ext/base/ndarray/saxpby $\\color{green}136/136$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}136/136$
$\\color{green}+100.00\\%$
constants/float32/e $\\color{green}53/53$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}53/53$
$\\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