docs: update descriptions

[Planeshifter]

Description

What is the purpose of this pull request?

This pull request:

• Aligns the lib/ndarray.js JSDoc summary line in 13 packages under @stdlib/lapack/base with the qualifier phrase ("using alternative indexing semantics" or "and alternative indexing semantics") that is already carried by each package's own README.md, docs/repl.txt, and docs/types/index.d.ts. In each case the ndarray JSDoc summary had been a copy of the strided (main) API summary, erasing the distinction that the other three doc surfaces already draw.

Namespace summary

Analyzed 32 packages (excluding the shared common-types module) under @stdlib/lapack/base. Structural features (file tree, package.json shape, README section list, manifest.json shape, test/benchmark/example naming) and semantic features (public signatures, validation prologues, error construction, JSDoc shape, dependencies) were extracted per package. Features with a clear majority (≥75% conformance): file tree, package.json keys, directories, engines, os, README section set, error construction via format (100%), TypeScript declarations, and per-file JSDoc @throws ↔ throw symmetry. Features without a clear majority (excluded from drift analysis): package.json extras (__stdlib__, browser, gypfile, present only for packages with native bindings), presence of C APIs README section (justified absent for pure-JS complex-arithmetic packages), presence of benchmark/benchmark.ndarray.js / lib/ndarray.js / test/test.ndarray.js (justified absent for scalar-input routines).

Per outlier package

lapack/base/clacgv

lib/ndarray.js summary omitted the "using alternative indexing semantics" qualifier that the package's own README.md, docs/repl.txt, and docs/types/index.d.ts already carry for the .ndarray API. Appended the qualifier so the four in-package doc surfaces agree.

lapack/base/claset

Same drift as sibling dlaset (which carries the qualifier). lib/ndarray.js summary now matches the package's own README (line 84), repl.txt, and TS declarations for the .ndarray overload.

lapack/base/claswp

Because the summary already contains a "using pivot indices stored in IPIV" clause, the ndarray-form qualifier is appended as "and alternative indexing semantics", matching the phrasing already used in the package's README (line 113), repl.txt, and TS declarations.

lapack/base/crot

The strided (main) API summary was reused verbatim for the .ndarray variant. Appended "using alternative indexing semantics" to restore the distinction, aligning with the phrasing the package's other doc surfaces already carry.

lapack/base/dladiv

The .ndarray JSDoc was a copy of the strided API summary. Appended "using alternative indexing semantics" to match the package's README (line 59), repl.txt, and TS declarations for the .ndarray overload.

lapack/base/dlarf

git log -S "alternative indexing semantics" shows the qualifier was propagated through README, repl, and TS but never landed in lib/ndarray.js. Appended it here so all four doc surfaces agree.

lapack/base/dlarf1f

Sibling of dlarf with an identical docs skeleton; same drift, same fix. lib/ndarray.js JSDoc summary now matches README, repl, and TS.

lapack/base/dlaswp

Appended "and alternative indexing semantics" (the qualifier variant used when the summary already contains a "using" clause), matching the phrasing the package's own README, repl.txt, and TS declarations already use for the .ndarray API.

lapack/base/slaswp

Mirror of dlaswp at single precision; same drift, same fix. Ndarray JSDoc summary now matches the phrasing in the package's other doc surfaces.

lapack/base/zlacgv

Mirror of clacgv at double precision. Appended "using alternative indexing semantics" so the .ndarray JSDoc summary matches the package's own README and repl.txt.

lapack/base/zlaset

Same drift as sibling dlaset (which carries the qualifier). Ndarray JSDoc summary now matches the package's own README (line 84), repl.txt, and TS declarations.

lapack/base/zlaswp

Mirror of dlaswp at double-precision complex; same drift, same fix. Ndarray JSDoc summary now matches the phrasing already present in the package's other doc surfaces.

lapack/base/zrot

Mirror of crot at double precision. The .ndarray JSDoc reused the strided API summary verbatim; appended "using alternative indexing semantics" to restore the distinction, matching the phrasing in the package's README, repl.txt, and TS declarations.

Validation

• Structural extraction ran across all 32 non-shared members, deriving majority patterns per feature (≥75% conformance threshold).
• Semantic extraction (public signatures, validation prologues, error construction, JSDoc shape) confirmed 100% conformance on format()-based error construction; per-file @throws ↔ throw symmetry holds across 24/25 files.
• Three-agent adversarial validation on the 13 outliers surfaced here: semantic-review returned confirmed-drift for all 13 (no intentional deviation); cross-reference confirmed no test or example under any of the 13 packages references the JSDoc summary text (safe to change); structural-review confirmed the fix direction (append to the 13 lacking JSDoc summaries; do not remove elsewhere).
• Deliberately excluded from this PR: intentional structural deviations justified by per-package semantics (xerbla exports a directory path, not a routine; disnan/dlaisnan/dlamch/dlapy2/dlapy3 are scalar-input functions with no .ndarray variant; pure-JS complex-arithmetic packages legitimately lack C APIs sections); one-line metadata tweaks that failed the materiality gate (missing routine-name keyword in dge-trans, sge-trans, xerbla package.json); the zrot parameter naming drift (strideX/strideY vs the sibling convention strideZX/strideZY) because a coherent fix would require touching docs/repl.txt, which is out of scope for this pass.

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.

Two orthogonal drift signals were flagged during review but not corrected in this PR (either because they require the same-group companion change or because they involve a generator-owned file):

• docs/types/index.d.ts in clacgv and zlacgv is also missing the "using alternative indexing semantics" qualifier on the .ndarray overload description; and dladiv's TS declaration uses "with" instead of "using".
• clacgv/README.md and zlacgv/README.md describe the input as "single-precision/double-precision floating-point vector" (missing "complex"), while the JSDoc, TS, and repl.txt in the same packages say "complex floating-point vector".

Checklist

Please ensure the following tasks are completed before submitting this pull request.

• Read, understood, and followed the contributing guidelines.

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

This PR was authored with AI assistance in the drift-detection loop: automated structural and semantic feature extraction across the 32 packages of @stdlib/lapack/base, majority computation per feature, and three-agent adversarial validation of the 13 outliers surfaced. The final diff — 13 one-line JSDoc summary edits, no code changes — was reviewed against each package's README, docs/repl.txt, and docs/types/index.d.ts before commit.

---

@stdlib-js/reviewers

---

Generated by Claude Code

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
lapack/base/clacgv	$\\color{green}227/227$ $\\color{green}+100.00\\%$	$\\color{green}12/12$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}227/227$ $\\color{green}+100.00\\%$
lapack/base/claset	$\\color{green}844/844$ $\\color{green}+100.00\\%$	$\\color{green}41/41$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}844/844$ $\\color{green}+100.00\\%$
lapack/base/claswp	$\\color{green}433/433$ $\\color{green}+100.00\\%$	$\\color{green}34/34$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}433/433$ $\\color{green}+100.00\\%$
lapack/base/crot	$\\color{green}283/283$ $\\color{green}+100.00\\%$	$\\color{green}12/12$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}283/283$ $\\color{green}+100.00\\%$
lapack/base/dladiv	$\\color{green}277/277$ $\\color{green}+100.00\\%$	$\\color{green}10/10$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}277/277$ $\\color{green}+100.00\\%$
lapack/base/dlarf	$\\color{green}457/457$ $\\color{green}+100.00\\%$	$\\color{green}40/40$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}457/457$ $\\color{green}+100.00\\%$
lapack/base/dlarf1f	$\\color{red}486/488$ $\\color{green}+99.59\\%$	$\\color{red}46/47$ $\\color{green}+97.87\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{red}486/488$ $\\color{green}+99.59\\%$
lapack/base/dlaswp	$\\color{green}404/404$ $\\color{green}+100.00\\%$	$\\color{green}34/34$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}404/404$ $\\color{green}+100.00\\%$
lapack/base/slaswp	$\\color{green}404/404$ $\\color{green}+100.00\\%$	$\\color{green}34/34$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}404/404$ $\\color{green}+100.00\\%$
lapack/base/zlacgv	$\\color{green}227/227$ $\\color{green}+100.00\\%$	$\\color{green}12/12$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}227/227$ $\\color{green}+100.00\\%$
lapack/base/zlaset	$\\color{green}844/844$ $\\color{green}+100.00\\%$	$\\color{green}41/41$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}844/844$ $\\color{green}+100.00\\%$
lapack/base/zlaswp	$\\color{green}433/433$ $\\color{green}+100.00\\%$	$\\color{green}34/34$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}433/433$ $\\color{green}+100.00\\%$
lapack/base/zrot	$\\color{green}282/282$ $\\color{green}+100.00\\%$	$\\color{green}12/12$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}282/282$ $\\color{green}+100.00\\%$

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