Skip to content

docs: fix typos and examples#11761

Merged
kgryte merged 4 commits into
developfrom
philipp/fix-commit-review-2026-04-24
Apr 25, 2026
Merged

docs: fix typos and examples#11761
kgryte merged 4 commits into
developfrom
philipp/fix-commit-review-2026-04-24

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Follow-up fixes for commits merged to develop between 2026-04-23 18:14 EDT (c660c8e) and 2026-04-24 03:56 PDT (588cd1d).

Description

Post-merge review of the last 24 hours of develop surfaced three high-signal issues in commits landed during the window. Each fix is a bounded, single-file edit that lands as its own commit.

Fixes (grouped by package):

blas/base/ndarray

  • Fix dswap @example block in fe150a0 (lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts) to use Float64Vector, consistent with all sibling function examples updated in the same commit.

types

  • Fix copy-paste error in b9502d5: the @example annotation in lib/node_modules/@stdlib/types/index.d.ts (line 673) incorrectly types the variable as Complex64Array instead of Complex32Array.

docs/migration-guides/numpy

  • Fix malformed Markdown in docs/migration-guides/numpy/README.md (line 49) by removing a stray trailing ] from the NumPy column of the "Flatten an array to a desired depth" row, left behind when 0e262c8 removed the leading [ but failed to drop its counterpart.

Related Issues

None.

Questions

No.

Other

Validation

  • Reviewed all 22 commits merged to develop in the 24h window (c660c8e..588cd1d).
  • Cross-checked with docs/style-guides/* and canonical sibling packages (dcopy for blas/base/ndarray, Complex64Array/Complex128Array interfaces for types).
  • Explicitly excluded from this PR: anything requiring interpretation or out-of-window validation, including the @stdlib/ndarray/rot180 link in the NumPy guide (likely a deliberate placeholder for a planned high-level package) and the template <!-- C interface documentation. --> comments in stats/base/dists/chi/cdf/README.md (present in 400+ sibling READMEs; not a clear violation).
  • Bot-generated namespace/REPL data file updates were not touched.

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 as part of an automated post-merge review pass over the last 24 hours of develop. Four review agents (two style, two bug) independently scanned the diff; only issues corroborated by multiple agents or independently re-verified against the diff were kept. PR is opened as draft for human audit before promotion.


@stdlib-js/reviewers


Generated by Claude Code

claude and others added 4 commits April 24, 2026 12:26
…larations

Align the newly-added `dswap` JSDoc example with the sibling entries
modernized in the same commit (use `Float64Vector` instead of the legacy
`Float64Array` + `ndarray/base/ctor` pattern).
Fix a copy-paste artifact in the `Complex32Array` JSDoc example which
annotated the example object with `Complex64Array` instead of
`Complex32Array`.
Drop a residual `]` left in the NumPy column of the reshape/flatten row
after the leading `[` was removed in an earlier typo fix.
@kgryte kgryte marked this pull request as ready for review April 24, 2026 22:43
@kgryte kgryte requested a review from a team April 24, 2026 22:43
@kgryte kgryte changed the title docs: follow-up fixes for commits merged to develop 2026-04-23/24 docs: follow-up fixes Apr 24, 2026
@kgryte kgryte changed the title docs: follow-up fixes docs: fix typos and examples Apr 24, 2026
@kgryte

kgryte commented Apr 24, 2026

Copy link
Copy Markdown
Member

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

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Apr 24, 2026
@kgryte kgryte merged commit 5a06940 into develop Apr 25, 2026
37 of 42 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-04-24 branch April 25, 2026 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants