Skip to content

docs: fix description and return annotations in new ndarray/base/*-like packages#12145

Draft
Planeshifter wants to merge 2 commits into
developfrom
philipp/fix-commit-review-2026-05-15
Draft

docs: fix description and return annotations in new ndarray/base/*-like packages#12145
Planeshifter wants to merge 2 commits into
developfrom
philipp/fix-commit-review-2026-05-15

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Follow-up fixes for commits merged to develop between 2026-05-14 18:46 UTC and 2026-05-15 11:20 UTC (commit range b517ce1..f0ed784, 21 commits reviewed). A post-merge review found two newly added packages carrying documentation defects:

  • ndarray/base/falses-like: Fix documentation defects introduced in 2dcfa84 — removed Markdown backticks from the description field in package.json (plain text, per convention in ndarray/base/falses and ndarray/base/nulls-like) and corrected the @returns tag in docs/types/index.d.ts from filled ndarray to `false`-filled array to match the value-qualified convention used across sibling packages.
  • ndarray/base/trues-like: Fix documentation defects introduced in 2e5a8c9 — removed Markdown backticks from the description field in package.json (plain-text convention, per ndarray/base/trues and ndarray/base/nulls-like) and corrected the @returns tag in docs/types/index.d.ts from filled ndarray to `true`-filled array to match the value-qualified convention used by zeros-like and nulls-like.

Each package's fixes are committed separately.

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Scope. All 21 commits merged to develop (first-parent) between 2026-05-14 18:46 UTC and 2026-05-15 11:20 UTC — a union diff of ~4900 insertions across 125 files: new ndarray/base/{falses,trues,nulls}-like packages, ndarray/base/{falses,trues} generic-dtype support, ndarray/base/{reverse,to-reversed} test/benchmark updates, ml/base/kmeans/algorithm-resolve-{str,enum}, the blas/base/dgemm resolveStr refactor, and bot-generated docs/declaration commits.

Validation performed.

  • Style-guide compliance: changed code audited against docs/style-guides and compared against established reference packages (ndarray/base/zeros-like, ndarray/base/nans-like, blas/base/transpose-operation-resolve-str, and the parent ndarray/base/{falses,trues} packages). Only the two package.json / .d.ts deviations above were confirmed.
  • Bug & security scan: the diff was scanned for incorrect logic, copy-paste errors, and security issues. No high-signal bugs were found — the falses-like/trues-like/nulls-like fill values, the kmeans resolvers, and the dgemm resolveStr refactor are all correct.

Deliberately excluded. Subjective suggestions, style preferences not mandated by the guide, "might-be" problems, and anything requiring changes outside the reviewed diff window to validate. Bot-generated namespace/TOC/declaration commits were noted but not modified.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance.

This pull request was authored by Claude Code as part of an automated post-merge review of commits merged to develop over the preceding 24 hours. Claude enumerated the commit range, ran a multi-agent style-compliance and bug/security review, validated each finding against established reference packages and docs/style-guides, and applied the documentation fixes. Changes should be independently audited before merge.


@stdlib-js/reviewers


Generated by Claude Code

@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/base/falses-like $\color{green}115/115$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}115/115$
$\color{green}+100.00%$
ndarray/base/trues-like $\color{green}115/115$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}115/115$
$\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