docs: document empty-matrix return value#13396
Merged
Merged
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jul 9, 2026
lapack/base/iladlr JSDoc
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:
## Notesblock to the publiciladlrJSDoc documenting the-1return value for empty and all-zero matrices.lapack/base/iladlrThe public wrapper's JSDoc was the sole member of the
iladl*family lacking the empty-matrix note. Its siblingiladlcdocuments this behavior inline, andiladlr's own private implementation (lib/base.js) carries the identical block. The added note is factually accurate:base.jsreturns-1forM <= 0 || N <= 0and falls through to-1when no non-zero element is encountered. Conformance across theiladl*family after this change: 100%.Related Issues
No.
Questions
No.
Other
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
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
Drift analysis across the
lapack/basenamespace 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