docs: propagate recent develop fixes to sibling packages#12446
Open
Planeshifter wants to merge 4 commits into
Open
docs: propagate recent develop fixes to sibling packages#12446Planeshifter wants to merge 4 commits into
Planeshifter wants to merge 4 commits into
Conversation
Propagates the wording fix from 839bce5 ("refactor: align iterator-validation error construction in three `@stdlib/iter` packages") to sibling factory packages in `random/array/tools`. The `isStringArray` check in each of `unary-factory`, `binary-factory`, and `ternary-factory` threw with `'... Second argument must an array of strings. Value: \`%s\`.'`, missing the verb "be"; corrected to "must be an array of strings" to match the canonical phrasing used elsewhere in the same files.
Propagates fixes from 8879b1d ("docs: tidy doc and C macro drift in `@stdlib/constants/float32`") to sibling `float64` packages with the same doc drift. Restores the canonical `https://en.wikipedia.org/wiki/E_(mathematical_constant)` Wikipedia URL in `log10-e` and `log2-e` (the percent-encoded form `E_%27...%28` mojibake produced a broken link), and renames README top-level headings in `nan`, `ninf`, and `pinf` to match the exported `FLOAT64_NAN`, `FLOAT64_NINF`, and `FLOAT64_PINF` constant names.
Propagates the wording fix from 0f2cc7c ("docs: update descriptions") to sibling READMEs in `blas/ext/base/dcartesian-power`, `blas/ext/base/scartesian-power`, and `blas/ext/base/gcartesian-power`. Replaces "stride length of the {first,second} dimension of \`out\`." with "stride length for the {first,second} dimension of \`out\`." in both the JS parameter list and the C API parameter list, matching the parallel "stride length for \`x\`." phrasing already present in each file.
Propagates the wording fix from f7a08b6 ("docs: align \`package.json\` descriptions with imperative-mood convention") to sibling packages whose \`description\` fields still use 3rd-person present-tense verbs. Updates \`math/base/special/hyp2f1\` ("Evaluates" -> "Evaluate"), \`math/base/special/gammasgnf\` ("Computes" -> "Compute"), and \`object/none-own-by\` ("Tests" -> "Test").
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Member
Author
|
/stdlib merge |
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
developbetweenf7a08b6c(2026-06-01 15:24 -0500) and2013317f(2026-06-02 05:02 -0500) to sibling packages with the same underlying defect.Pattern: insert missing "be" in dtype-validation error messages
Source commit
839bce5a6corrected'... First argument must an iterator protocol-compliant object. Value: \%s`.'to "must be an" in three@stdlib/iterpackages. The identical missing-bedefect exists in theisStringArray( dtypes )guard of threerandom/array/tools/*-factorypackages, with the noun "array of strings" in place of "iterator protocol-compliant object". The fix matches the canonical phrasing already used in the neighbouringmust be a supported data type` guard in the same files.839bce5a6(refactor: align iterator-validation error construction in three @stdlib/iter packages)@stdlib/random/array/tools/unary-factory@stdlib/random/array/tools/binary-factory@stdlib/random/array/tools/ternary-factoryPattern: tidy doc drift in
@stdlib/constants/float64Source commit
8879b1d32tidied two classes of doc drift in@stdlib/constants/float32: a corrupted Wikipedia URL where%27...%28(i.e. an apostrophe and an open paren) replaced the literal parentheses, and a README top-level heading whose name did not match the exported constant. The same Wikipedia URL mojibake exists in thelog10-eandlog2-epackages underconstants/float64; the same heading-vs-export mismatch exists in thenan,ninf, andpinfpackages, whose READMEs lead with# NAN/# NINF/# PINFeven thoughlib/index.jsexportsFLOAT64_NAN/FLOAT64_NINF/FLOAT64_PINF.8879b1d32(docs: tidy doc and C macro drift in @stdlib/constants/float32)@stdlib/constants/float64/log10-e@stdlib/constants/float64/log2-e@stdlib/constants/float64/nan@stdlib/constants/float64/ninf@stdlib/constants/float64/pinfPattern: align "stride length" wording in
blas/ext/base/*cartesian-powerSource commit
0f2cc7c6ereplacedstride length of the {first,second} dimension of \out`.withstride length for the ... dimension of `out`.indcartesian-square's README, matching thestride length for `x`.phrasing of the input-stride bullet in the same parameter list. The identical defect exists in thedcartesian-power,scartesian-power, andgcartesian-power` siblings, in both the JS and C-API parameter lists.0f2cc7c6e(docs: update descriptions)@stdlib/blas/ext/base/dcartesian-power@stdlib/blas/ext/base/scartesian-power@stdlib/blas/ext/base/gcartesian-powerPattern: align
package.jsondescriptions with imperative moodSource commit
f7a08b6cealigned three package descriptions ("Performs", "Returns", "Calculates") with the imperative-mood convention. An exhaustive sweep of all 5,637package.jsonfiles underlib/node_modules/@stdlib/surfaces only three remaining sites, each a mechanical drop-the-ssubstitution.f7a08b6ce(docs: align package.json descriptions with imperative-mood convention)@stdlib/math/base/special/hyp2f1(Evaluates→Evaluate)@stdlib/math/base/special/gammasgnf(Computes→Compute)@stdlib/object/none-own-by(Tests→Test)Related Issues
None.
Questions
No.
Other
Validation
random/array/tools/*-factoryfor themust antypo by analogy to theitersource;constants/float64/*for the URL and README-title drift;blas/ext/base/*cartesian-*for the stride-length wording; all 5,637package.jsonfiles for the imperative-mood sweep), widened only when warranted by the pattern signature.confirmedfrom both passes.format()usage andmust be a/anphrasing for the error messages, parallelfor \x`wording for the stride-length bullets, namespace-prefixed exported-constant naming for the README headings, and the imperative-mood convention shared by siblingpackage.json` descriptions in the same namespace.Deliberately excluded:
data.csv/data.jsonentries under@stdlib/error/tools/database/data/that mirror the oldmust an iteratortext: the database assigns stable error codes ("44"here) to message text and never rewrites existing entries on regeneration. Touching the records would invalidate the stable error-code → message contract; the build script will assign a new code for the corrected message on the next regeneration. Logged.expm1relnumerical-accuracy fix from0a659c475: the identity-substitution method is specific toexpm1(x)/xand does not generalise as a search signature.f-suffix fix from8879b1d32: an exhaustive sweep of allSTDLIB_CONSTANT_FLOAT32_*macros inconstants/float32/*/include/found that every remaining decimal-literal macro is already correctly suffixed.// returns 4.0annotation fix fromf84f6d09d/9f0e49e68: a full sweep acrossblas/base/**andblas/base/ndarray/**found no remainingi*amax-style decimal-as-integer annotations.to Find→to findcapitalisation fix from9f0e49e68: a full sweep acrosslib/node_modules/@stdlib/found that the only remaining\bto [A-Z][a-z]+ the\bmatches are intentional title-case citations of the 1978 Blue paper "A Portable Fortran Program to Find the Euclidean Norm of a Vector".chore: add missing classification keywords in @stdlib/math/base/assert(2013317f): the commit only touchespackage.jsonfiles, excluded forchore:sources per routine rules.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code on behalf of @Planeshifter as an automated propagation of fixes merged to
developover the prior 24 hours. Candidate source commits were filtered for generalisable patterns, sibling sites located via grep-able pattern signatures, and each proposed patch independently validated by parallel reviewer agents (two opus validation passes plus a sonnet style-consistency pass) before commits were applied in the primary worktree. A human will audit and promote the PR out of draft.@stdlib-js/reviewers
Generated by Claude Code