Skip to content

docs: document empty-matrix return value#13396

Merged
kgryte merged 1 commit into
developfrom
philipp/drift-lapack-base-2026-07-09
Jul 9, 2026
Merged

docs: document empty-matrix return value#13396
kgryte merged 1 commit into
developfrom
philipp/drift-lapack-base-2026-07-09

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • adds a ## Notes block to the public iladlr JSDoc documenting the -1 return value for empty and all-zero matrices.

lapack/base/iladlr

The public wrapper's JSDoc was the sole member of the iladl* family lacking the empty-matrix note. Its sibling iladlc documents this behavior inline, and iladlr's own private implementation (lib/base.js) carries the identical block. The added note is factually accurate: base.js returns -1 for M <= 0 || N <= 0 and falls through to -1 when no non-zero element is encountered. Conformance across the iladl* family after this change: 100%.

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.

Sibling reference: lib/node_modules/@stdlib/lapack/base/iladlc/lib/iladlc.js. Private impl already documenting the same behavior: lib/node_modules/@stdlib/lapack/base/iladlr/lib/base.js. No test, example, or observable behavior changes — JSDoc only.

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

Drift analysis across the lapack/base namespace was performed by Claude Code as part of an automated cross-package audit. The single surviving correction (this JSDoc block) was manually verified against the sibling package and the private implementation before commit.



Generated by Claude Code

Add a `## Notes` block to the public `iladlr` JSDoc documenting the
empty-matrix / all-zero-matrix return value of `-1`. The sibling package
`iladlc` already carries this note (96% of `iladl*` peers conform), and
the private `iladlr/lib/base.js` implementation likewise documents and
returns `-1` for `M <= 0 || N <= 0` and for matrices containing only
zeros. The public wrapper's JSDoc was the sole outlier.
@stdlib-bot stdlib-bot added the LAPACK Issue or pull request related to the Linear Algebra Package (LAPACK). label Jul 9, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
lapack/base/iladlr $\\color{red}375/377$
$\\color{green}+99.47\\%$
$\\color{red}36/37$
$\\color{green}+97.30\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{red}375/377$
$\\color{green}+99.47\\%$

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

@kgryte kgryte marked this pull request as ready for review July 9, 2026 23:39
@kgryte kgryte requested a review from a team July 9, 2026 23:39
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 9, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jul 9, 2026
@kgryte kgryte changed the title docs: document empty-matrix return value in lapack/base/iladlr JSDoc docs: document empty-matrix return value Jul 9, 2026
@kgryte kgryte merged commit 2ad0b70 into develop Jul 9, 2026
70 checks passed
@kgryte kgryte deleted the philipp/drift-lapack-base-2026-07-09 branch July 9, 2026 23: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. 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