Repository navigation
docs: fix JSDoc parameter types in lapack/base/iladlc and lapack/base/iladlr - #16220
Merged
Merged
Conversation
Type `LDA` as `PositiveInteger` in lib/iladlc.js, matching the `LDA < max(1,s)` RangeError guard and the leading-dimension convention used in 15/17 (88%) sibling packages. Type `M` and `N` as `NonNegativeInteger` in lib/iladlc.js, lib/ndarray.js, and lib/base.js. The implementation returns `-1` for empty matrices and tests exercise `M = 0` and `N = 0`; matches 11/13 (85%) sibling matrix routines. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01P7vVhbw1EERFwQJuyT1rh8
Type `LDA` as `PositiveInteger` in lib/iladlr.js, matching the `LDA < max(1,s)` RangeError guard and the leading-dimension convention used in 15/17 (88%) sibling packages. Type `M` and `N` as `NonNegativeInteger` in lib/iladlr.js, lib/ndarray.js, and lib/base.js. The implementation returns `-1` for empty matrices and tests exercise `M = 0` and `N = 0`; matches 11/13 (85%) sibling matrix routines. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01P7vVhbw1EERFwQJuyT1rh8
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
October 24, 2026 02:31
kgryte
approved these changes
Oct 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request:
lapack/base/iladlcandlapack/base/iladlrso that they match their implementations and the conventions used acrosslapack/base.lapack/base/iladlcRetypes
LDAfromintegertoPositiveIntegerinlib/iladlc.js. TheLDA < max(1,s)guard already enforces this, and 15 of the 17 packages with a leading-dimension parameter (88%) use the same type. RetypesMandNfromPositiveIntegertoNonNegativeIntegerinlib/iladlc.js,lib/ndarray.js, andlib/base.js. Empty matrices return-1and the tests coverM = 0andN = 0; 11 of the 13 matrix routines (85%) useNonNegativeInteger.lapack/base/iladlrSame corrections as
iladlc:LDAbecomesPositiveIntegerinlib/iladlr.js(88%), andM/NbecomeNonNegativeIntegerinlib/iladlr.js,lib/ndarray.js, andlib/base.js(85%). The empty-matrix early return inlib/base.jsand the tests attest/test.iladlr.jsalready allow zero dimensions.Related Issues
None.
Questions
No.
Other
These corrections came from a cross-package consistency check of
lapack/base.Namespace summary. 34 members, with no autogenerated packages. Structural features analyzed: file tree,
package.jsonkeys,manifest.jsonkeys, and README sections. Semantic features analyzed: public signature, validation prologue, error construction, JSDoc shape, and dependencies. Features with a clear majority (≥75%) included the core file tree (85%), README sections, leading-dimension parameter types (88%),M/Nparameter types in matrix routines (85%), and leading-dimension validation in BLAS-style APIs (87%). Error construction (59%format, the rest throw nothing) and return kind had no clear majority and were excluded.Validation. Every package was checked for both structural and semantic features, and each candidate correction was then reviewed by three agents (semantic intent, cross-reference against tests and docs, structural applicability). Only JSDoc changes survived. The following were deliberately left out:
disnan,dlaisnan,dlamch,dlapy2,dlapy3) and in the C-support packages (shared,xerbla). These are intentional.RangeErrorchecks indge-transandsge-trans. Adding them would change observable behavior and needs a decision on the bound for the transposed output.C APIsplaceholder sections. Only 32% of stdlib READMEs have one.docs/repl.txtanddocs/types/index.d.tsare unchanged; they already match the majority wording.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code as part of an automated cross-package consistency check.
@stdlib-js/reviewers
Generated by Claude Code