Skip to content

docs: update type - #16330

Merged
kgryte merged 4 commits into
developfrom
claude/trusting-cannon-isetn9
Oct 29, 2026
Merged

kgryte merged 4 commits into
developfrom
claude/trusting-cannon-isetn9

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • propagates fixes merged to develop between 2026-10-26 13:34 UTC and 2026-10-27 13:34 UTC to sibling packages.
  • propagates the N JSDoc type correction from 7bf6853 (chore: clean-up), which retyped N as NonNegativeInteger in lapack/base/*laswp. The same PositiveInteger annotation remained in four lapack/base packages whose ndarray kernels return early when N <= 0, as reference LAPACK does, and whose tests check N = 0. Target packages:
    • lapack/base/clacgv
    • lapack/base/zlacgv
    • lapack/base/crot
    • lapack/base/zrot

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:

  • lapack/base/dlaswp

What carried over from the reference(s)?

  • The {NonNegativeInteger} N JSDoc type from 7bf6853.

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

  • 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.

Validation: I searched for @param {PositiveInteger} N across lapack/base/*/lib. Two independent validation passes read each target file and its ndarray callee, and both confirmed all 8 sites. A runtime check with N = 0 and N = -1 returned the inputs unchanged. A style and adaptation pass confirmed the change applies verbatim, with no cascade into docs/types, README, repl.txt, or tests. After this change, no lapack/base/*/lib file documents N as PositiveInteger.

Excluded:

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 fix-propagation routine.


@stdlib-js/reviewers


Generated by Claude Code

Propagates fix from 7bf6853 ("chore: clean-up") to sibling packages documenting `N` as `PositiveInteger` despite accepting `N = 0` as a no-op.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD78YjA2bMx3817c7htZ
@stdlib-bot stdlib-bot added the LAPACK Issue or pull request related to the Linear Algebra Package (LAPACK). label Oct 27, 2026
@stdlib-bot

stdlib-bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
lapack/base/clacgv $\\color{green}227/227$
$\\color{green}+0.00\\%$
$\\color{green}12/12$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}227/227$
$\\color{green}+0.00\\%$
lapack/base/crot $\\color{green}283/283$
$\\color{green}+0.00\\%$
$\\color{green}12/12$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}283/283$
$\\color{green}+0.00\\%$
lapack/base/zlacgv $\\color{green}227/227$
$\\color{green}+0.00\\%$
$\\color{green}12/12$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}227/227$
$\\color{green}+0.00\\%$
lapack/base/zrot $\\color{green}282/282$
$\\color{green}+0.00\\%$
$\\color{green}12/12$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}282/282$
$\\color{green}+0.00\\%$

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

Ports the fix from #16328 to resolve the CI dependency installation failure (`binding.gyp not found` when building `@kaciras/deasync`). No-op once the base branch carries the same change.

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

Copy link
Copy Markdown
Member Author

Check licenses failed during npm install: @kaciras/deasync fails to build (binding.gyp not found). This PR does not cause it. The same check fails on other open PRs (e.g., the run for #16329 before its port) because the floating ^1.0.1 range now resolves to a broken release.

I ported the pin from #16328 (@kaciras/deasync → 1.0.4) in 72c318a. It becomes a no-op once develop carries the same change.


Generated by Claude Code

@stdlib-bot stdlib-bot added the Merge Conflicts Pull request which has merge conflicts. label Oct 29, 2026

Copy link
Copy Markdown
Member Author

Run changed examples fails on aded31b, and this PR's diff does not cause it. The check ran because the merge of develop added its Markdown files (e.g., blas/ext/base/gxsadb/README.md) to the changed-file list. The error is a stale path on develop:

Error: Cannot find module './../../eslint.flat.config.js'
Require stack:
- etc/eslint/eslint.flat.config.markdown.js

The gh54 ESLint migration renamed eslint.flat.config.js to eslint.config.js, but etc/eslint/eslint.flat.config.markdown.js:24 still requires the old path. This affects every PR that changes a README with JavaScript examples. I found no open fix, so here is the proposed one-line patch rather than widening this PR:

-var defaults = require( './../../eslint.flat.config.js' );
+var defaults = require( './../../eslint.config.js' );

Re-running would fail the same way, so I did not re-run.


Generated by Claude Code

Copy link
Copy Markdown
Member Author

Run affected tests on aded31b hit the 30-minute job timeout while running random/base/* tests. Every test that finished passed. The job computed its affected set from the push's diff range, and this push was the develop merge. That range carries develop's repo-wide ESLint/tooling changes (e.g., .npmrc and etc/eslint/*), so the job tested far beyond this PR's 8 changed lines in lapack/base/{clacgv,zlacgv,crot,zrot}. The same packages passed Run affected tests on 72c318a.

Both remaining red checks clear on the next push whose range is limited to this PR's files: this one and Run changed examples (see above). That push will be the develop merge that brings in the ESLint config path fix.


Generated by Claude Code

@kgryte kgryte removed the Merge Conflicts Pull request which has merge conflicts. label Oct 29, 2026
@kgryte
kgryte marked this pull request as ready for review October 29, 2026 11:00
@kgryte
kgryte requested a review from a team October 29, 2026 11:00
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Oct 29, 2026
@kgryte kgryte changed the title chore: update N parameter type in lapack/base/* JSDoc docs: update type Oct 29, 2026
@kgryte
kgryte merged commit 4e877c8 into develop Oct 29, 2026
31 checks passed
@kgryte
kgryte deleted the claude/trusting-cannon-isetn9 branch October 29, 2026 11:02
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

LAPACK Issue or pull request related to the Linear Algebra Package (LAPACK).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants