Skip to content

chore: minor clean-up#11951

Open
Planeshifter wants to merge 9 commits intodevelopfrom
philipp/fix-commit-review-2026-05-05
Open

chore: minor clean-up#11951
Planeshifter wants to merge 9 commits intodevelopfrom
philipp/fix-commit-review-2026-05-05

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

@Planeshifter Planeshifter commented May 5, 2026

Description

What is the purpose of this pull request?

Follow-up fixes for commits merged to develop between 2026-05-04 14:00 PDT (a3a5677b7b) and 2026-05-05 03:03 PDT (c5fad82b2).

This pull request:

  • Fixes documentation and header-guard inconsistencies introduced in 73653a29d for lib/node_modules/@stdlib/stats/strided/distances/dcorrelation: aligns the README tagline, JS-API descriptions, removes an orphan <!-- </equation> --> tag, deduplicates a $ExpectError line in docs/types/test.ts that masked a missing 5-arg negative case, and renames the include guard to STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H to match the full package path.
  • Aligns lib/node_modules/@stdlib/blas/ext/base/gcartesian-power with sibling dcartesian-power/scartesian-power (originating commit 181b4cc56): switches strideOut1/strideOut2 README descriptions from "stride length for" to "stride length of", and rewrites the createBenchmark JSDoc summaries in benchmark/benchmark.js and benchmark/benchmark.ndarray.js

Related Issues

Does this pull request have any related issues?

No.

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.

Validation. Each finding was independently flagged by at least one reviewer agent and re-verified by re-reading the diff and the affected file. Compliance was checked against docs/style-guides and against established sibling packages (dcartesian-power/scartesian-power for the cartesian-power family, dscal/sscal/gscal/zscal for the BLAS ndarray wrappers, deuclidean/dcosine-distance/dminkowski for strided distances). Deliberately excluded: anything requiring interpretation, anything that could not be validated without touching code outside the diff window, and several false positives that did not survive verification (e.g., empty <intro>/<notes> README sections in cscal — siblings have the same structure; an alleged missing scartesian-power benchmark "Creates" — the file already uses imperative).

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 prepared by Claude Code: the diff window was reviewed by four parallel agents (two style-guide compliance, two bug-hunting), every flagged issue was re-verified against the actual files in the worktree, false positives were filtered, and the surviving fixes were applied and grouped into per-package commits. Maintainer review of every change is expected before merge.


@stdlib-js/reviewers


Generated by Claude Code

@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented May 5, 2026

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/gcartesian-power $\color{green}364/364$
$\color{green}+0.00%$
$\color{green}34/34$
$\color{green}+0.00%$
$\color{green}3/3$
$\color{green}+0.00%$
$\color{green}364/364$
$\color{green}+0.00%$
blas/ext/base/scartesian-power $\color{green}462/462$
$\color{green}+100.00%$
$\color{green}39/39$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}462/462$
$\color{green}+100.00%$
stats/strided/distances/dcorrelation $\color{green}366/366$
$\color{green}+0.00%$
$\color{green}15/15$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}366/366$
$\color{green}+0.00%$

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

Comment thread lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts
…view

Reverts:
- 0f14066 (operator spacing in `_tools/eslint/rules/line-closing-bracket-spacing`)
- 8634b93 (`cscal`/`gscal` in `blas/base/ndarray` namespace types)
- fa775c5 (`dcorrelation` in `stats/strided/distances` namespace types)

Namespace TS declarations are auto-generated and should not be hand-edited.

https://claude.ai/code/session_01PYMuhnRSCirT5T3Bn4o4Lj
Comment thread lib/node_modules/@stdlib/blas/ext/base/gcartesian-power/benchmark/benchmark.js Outdated
Comment thread lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/docs/repl.txt Outdated
claude added 3 commits May 5, 2026 14:45
…es/dcorrelation` REPL help

Per maintainer review: the explicit guard in the implementation is `N <= 0`, so the REPL help should match.

https://claude.ai/code/session_01PYMuhnRSCirT5T3Bn4o4Lj
…se/gcartesian-power`

Per maintainer review: "Creates" (third-person indicative) is the convention for these benchmark JSDoc summaries, not the imperative.

https://claude.ai/code/session_01PYMuhnRSCirT5T3Bn4o4Lj
…n-power` benchmark JSDoc

Aligns with the convention reaffirmed in maintainer review: third-person indicative, not imperative.

https://claude.ai/code/session_01PYMuhnRSCirT5T3Bn4o4Lj
@Planeshifter Planeshifter changed the title fix: follow-up fixes for commits merged to develop on 2026-05-04/05 chore: minor clean-up May 5, 2026
@Planeshifter Planeshifter marked this pull request as ready for review May 5, 2026 14:50
@Planeshifter Planeshifter requested review from a team and kgryte May 5, 2026 14:50
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Review A pull request which needs code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants