Skip to content

chore: clean-up - #16551

Merged
kgryte merged 2 commits into
developfrom
claude/cool-johnson-oyvupo
Nov 10, 2026
Merged

kgryte merged 2 commits into
developfrom
claude/cool-johnson-oyvupo

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • adds the README notes section to ndarray/hconcat and the ndarray keyword to ndarray/array, which are the only two packages in the ndarray namespace that lack them.

Namespace summary

  • 134 direct member packages of @stdlib/ndarray (sub-namespaces base, iter, matrix, and vector excluded). Majority threshold: ≥101 packages (75%).
  • Features analyzed: file tree, package.json key sets and constant values, keywords, README ##/### headings and <section> blocks, error construction, JSDoc @throws/@returns/@example coverage, and source dependencies.
  • Features with a clear majority: core file set, package.json key set, README section blocks, keywords, JSDoc shape, and engines/directories values.
  • Features without a clear majority (excluded): error construction (format-only is 93/134; the rest pair format with plain literals for constant messages, which stdlib/no-unnecessary-format requires) and README ### headings.

ndarray/hconcat

README.md is missing the notes section between usage and examples. 133 of 134 siblings (99%) have it. This adds the empty scaffold, matching ndarray/concat. No note content is added, because hconcat concatenates along the last dimension and, unlike vconcat, has no dimensionality constraint to document.

ndarray/array

package.json keywords omits ndarray, while 133 of 134 siblings (99%) list it. This adds it after array.

Related Issues

Does this pull request have any related issues?

None.

Reference Packages

Did the content of this pull request follow one or more existing packages? Answering is optional.

This pull request followed these packages:

  • ndarray/concat
  • ndarray/vconcat

What carried over from the reference(s)?

  • README notes section scaffold and the ndarray keyword.

What differed, or what did you have to work out yourself?

  • Whether the vconcat note applies to hconcat. It does not.

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.

Drift validation: structural features were extracted from the filesystem, semantic features were extracted from lib/main.js, lib/index.js, and lib/validate.js, and three independent agents reviewed the outliers (semantic, cross-reference, structural).

Deliberately excluded:

  • Benchmark/example layouts split by dimension or by example (e.g., benchmark.1d.js, examples/add.js), and engines.node >=6.0.0 in fancy/to-fancy, which use Proxy.
  • The 26-package cohort (any, every, map, ...) that lacks the types/stdtypes keywords and the references section. This is a consistent template difference.
  • Generator-owned artifacts: the missing docs/repl.txt and docs/types in dispatch-by, and the missing docs/types in to-fancy.

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 helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code as part of an automated cross-package drift-detection run.



Generated by Claude Code

Added the empty `notes` section scaffold between the usage and examples sections (present in 133 of 134 `ndarray/*` READMEs, 99%).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD77ZYjmbZKTtbm3qouj
Added `ndarray` to `keywords` in `package.json` (present in 133 of 134 `ndarray/*` packages, 99%).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD77ZYjmbZKTtbm3qouj
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/array $\\color{red}612/827$
$\\color{green}+74.00\\%$
$\\color{red}38/61$
$\\color{green}+62.30\\%$
$\\color{red}3/7$
$\\color{green}+42.86\\%$
$\\color{red}612/827$
$\\color{green}+74.00\\%$
ndarray/hconcat $\\color{green}184/184$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}184/184$
$\\color{green}+100.00\\%$

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

Copy link
Copy Markdown
Member Author

Run affected tests fails in blas/ext/circshift/test/test.js. This is not caused by this PR.


Generated by Claude Code

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Nov 10, 2026
@kgryte
kgryte marked this pull request as ready for review November 10, 2026 02:05
@kgryte
kgryte requested a review from a team November 10, 2026 02:05
@kgryte

kgryte commented Nov 10, 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 changed the title docs: add missing notes section to ndarray/hconcat and ndarray keyword to ndarray/array chore: clean-up Nov 10, 2026
@kgryte
kgryte merged commit c53f49c into develop Nov 10, 2026
34 of 36 checks passed
@kgryte
kgryte deleted the claude/cool-johnson-oyvupo branch November 10, 2026 02:06
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Nov 10, 2026
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.

4 participants