docs: propagate description and example fixes to sibling packages#13059
Draft
Planeshifter wants to merge 2 commits into
Draft
docs: propagate description and example fixes to sibling packages#13059Planeshifter wants to merge 2 commits into
Planeshifter wants to merge 2 commits into
Conversation
…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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Propagating fixes merged to
developbetween 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}axpbySource: d826990 ("docs: update function descriptions"). Adds the "one-dimensional" qualifier to the brief description in
lib/index.js,lib/main.js, andpackage.jsonfor two sibling packages whose READMEs, TypeScript declarations, REPL help, and JSDoc## Notessections already document them as operating on one-dimensional ndarrays. Mirrors thedxpy/sxpyprecedent exactly.blas/ext/base/ndarray/daxpbyblas/ext/base/ndarray/saxpbychore:propagateFLOAT32_-prefixed example variable toconstants/float32/eSource: 4154fdc ("chore: update examples and add keyword"). Renames the JSDoc
@examplevariable fromEtoFLOAT32_Einlib/index.js, aligning the package with theFLOAT32_-prefixed naming convention used by every otherconstants/float32/*package.constants/float32/eRelated Issues
No.
Questions
No.
Other
Validation
blas/ext/base/ndarray/*andconstants/float32/*).{d,s}axpbytargets; every otherconstants/float32/*package uses theFLOAT32_prefix).Deliberately excluded
stats/base/ndarray/*/src/addon.cfiles already use the const-qualified pointer-list pattern; no sites remain.*xsyREADME copy fix (f87196f) — siblingcxsy,gxsy,sxsy,zxsyREADMEs already use the corrected "subtract" wording.PDF→PMFtypo fix (83e6c53) — no remaining"probability mass function (PDF)"or"probability density function (PMF)"instances understats/ormath/."number"keyword +// MAIN //heading additions (68d7a66) — allnumber/float64/base/*packages already have the keyword and section heading.array/base/rejecttyped-array return annotation fix (794978c, ed5107b) — limited to the originating package; no sibling exhibits the same incorrect type annotation.E→FLOAT32_Erename inconstants/float32/e/README.md(lines 30, 55) was held out — the source commit narrowed scope to the JSDoc@exampleblock inlib/index.js. A follow-up can sweep the README if desired.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated routine that scans recent
developcommits 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