Skip to content

docs: fix signatures#13426

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-07-11
Jul 11, 2026
Merged

docs: fix signatures#13426
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-07-11

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between 2026-07-10 12:54 PDT (e713916) and 2026-07-11 00:41 PDT (4da2dcf) to sibling packages carrying the same defect.

Pattern: missing .ndarray prefix on ndarray-variant REPL signature header

Commit e713916 corrected the .ndarray variant signature header in blas/ext/base/sfirst-index-equal/docs/repl.txt — the alternative-indexing section's header line read {{alias}}( N, ... ) rather than {{alias}}.ndarray( N, ... ), so REPL ? help displayed the wrong signature. The same defect is present in three sibling blas/ext/base packages: in each docs/repl.txt, the second signature block is documented as the alternative-indexing variant (mentions "alternative indexing semantics", accepts offsetX, example calls {{alias}}.ndarray(...)), but its header omits the .ndarray prefix. Fix is one line per file: prepend .ndarray to the header.

  • e713916 (chore: clean-up)
    • blas/ext/base/gindex-of
    • blas/ext/base/sindex-of
    • blas/ext/base/dindex-of

Related Issues

No.

Questions

No.

Other

Validation

  • Search scope. **/docs/repl.txt files under lib/node_modules/@stdlib/, filtered to files that (a) contain both a bare {{alias}}( header with no offset parameter and a bare {{alias}}( header with an offset parameter, and (b) contain no {{alias}}.ndarray( header. This bounded the candidate set to exactly the three *index-of files above.
  • Two independent Opus validation agents each read every candidate file in full and confirmed that (a) the flagged header sits above a section whose description explicitly reads "using alternative indexing semantics", accepts an offsetX parameter, and whose Examples block already calls {{alias}}.ndarray(...); (b) a distinct main-variant signature (no offset) lives at the top of the same file; (c) prepending .ndarray is a safe, self-contained one-line edit.
  • Adaptation pass confirmed the source patch shape applies verbatim (no per-site tailoring, no cross-file cascade).
  • Style-consistency pass confirmed spacing (single space inside parens, comma-space argument separators) and the blank-line separation from the preceding block match the post-fix sfirst-index-equal reference exactly.

Deliberately excluded:

  • The dfirst-index-equal/docs/repl.txt sentence-terminating period and paragraph-break fix from e713916: a repo-wide search for the same signature (description sentence ending without a period, followed by a continuation paragraph on the next line without an intervening blank line) returned no other REPL doc with the same defect.
  • The sfirst-index-equal/README.md <!-- lint disable maximum-heading-length -->enable correction from e713916: candidate READMEs (blas/ext/base/{gdiff,ddiff,sdiff}, blas/base/cgemv) carry a related but structurally different defect (multiple unclosed disable directives, each requiring insertion of a paired enable — not a disableenable transform). The fix shape is not a direct analog of the source patch and would need adaptive per-site inserts. Logged for a future run.
  • The dfirst-index-equal/docs/types/index.d.ts declare constdeclare var change from e713916: a repo-wide search for ^declare const \w+: Routine; in **/docs/types/index.d.ts returned zero matches. The source commit closed the last remaining site.
  • feat: commits in the window (sreplicate/dreplicate package additions, gammaincinv C implementation, TypeScript declaration updates): not fix patterns.
  • docs: update namespace table of contents (31d535d, stdlib-bot): generator-owned files.

Checklist

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 on behalf of @Planeshifter as an automated propagation of fixes merged to develop over the prior 24 hours. Candidate source commits were filtered for generalizable patterns, sibling sites located via grep-able pattern signatures, and each proposed patch independently validated by parallel reviewer agents (two Opus validation passes, an adaptation pass, and a style-consistency pass) before commits were applied in the primary worktree. A maintainer should audit and promote out of draft.



Generated by Claude Code

Propagates the REPL-signature fix from e713916 ("chore: clean-up") to
`blas/ext/base/gindex-of`, `blas/ext/base/sindex-of`, and
`blas/ext/base/dindex-of`, whose `.ndarray` variant signature headers
were missing the `.ndarray` alias prefix.
@stdlib-bot stdlib-bot added the BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). label Jul 11, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/dindex-of $\\color{green}357/357$
$\\color{green}+100.00\\%$
$\\color{green}19/19$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}357/357$
$\\color{green}+100.00\\%$
blas/ext/base/gindex-of $\\color{green}248/248$
$\\color{green}+100.00\\%$
$\\color{green}18/18$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}248/248$
$\\color{green}+100.00\\%$
blas/ext/base/sindex-of $\\color{green}357/357$
$\\color{green}+100.00\\%$
$\\color{green}19/19$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}357/357$
$\\color{green}+100.00\\%$

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

@Planeshifter Planeshifter changed the title chore: propagate .ndarray REPL signature fix to blas/ext/base/*index-of docs: propagate .ndarray REPL signature fix to blas/ext/base/*index-of Jul 11, 2026
@Planeshifter Planeshifter marked this pull request as ready for review July 11, 2026 22:19
@Planeshifter Planeshifter requested review from a team and kgryte July 11, 2026 22:19
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 11, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jul 11, 2026
@kgryte kgryte changed the title docs: propagate .ndarray REPL signature fix to blas/ext/base/*index-of docs: fix signatures Jul 11, 2026
@kgryte kgryte merged commit e48bed5 into develop Jul 11, 2026
58 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-07-11 branch July 11, 2026 23:36
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Jul 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants