docs: add C APIs placeholder section to four lapack/base package READMEs#12263
Draft
Planeshifter wants to merge 4 commits into
Draft
docs: add C APIs placeholder section to four lapack/base package READMEs#12263Planeshifter wants to merge 4 commits into
C APIs placeholder section to four lapack/base package READMEs#12263Planeshifter wants to merge 4 commits into
Conversation
Inserts the standard C APIs placeholder block, present in 26 of 30 `lapack/base` packages (87% conformance), into the README. The package previously skipped this template section.
Inserts the standard C APIs placeholder block, present in 26 of 30 `lapack/base` packages (87% conformance), into the README. The package previously skipped this template section.
Inserts the standard C APIs placeholder block, present in 26 of 30 `lapack/base` packages (87% conformance), into the README. The package previously skipped this template section.
Inserts the standard C APIs placeholder block, present in 26 of 30 `lapack/base` packages (87% conformance), into the README. The package previously skipped this template section.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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:
## C APIsplaceholder section to the READMEs of four@stdlib/lapack/basepackages that were missing it:clacgv,crot,zlacgv, andzrot. The section is present in 26 of 30lapack/basepackages (87% conformance), and the inserted block is byte-identical to the template used by sibling packages such asclaset,claswp,zlacpy, andzlaset.Namespace summary
@stdlib/lapack/baseshared,xerbla,dlamch,dlapy2,dlapy3retained in the structural pass but recognized as non-array/utility packages for which several majority features are intentionally inapplicable).## C APIsREADME section (87%), presence of## NotesREADME section (93%), presence oflib/ndarray.js(83%), presence oftest/test.ndarray.js(83%), presence ofbenchmark/benchmark.js(93%), keyword set includingalgebra/linear/math/stdmath/subroutines(97%).browserfield inpackage.json(20%),__stdlib__field (20%),lib/base.js(70%),gypfile(7%).## C APIssection inclacgv,crot,zlacgv,zrot(4 outliers).ndarray.js/test.ndarray.js/benchmark.ndarray.jsindlamch/dlapy2/dlapy3(these are scalar operations and have no array variant by design); missinglib/base.jsinclacgv/crot/zlacgv/zrot(these are 1D vector operations whose stride variants delegate directly to ndarray, no shared base implementation is warranted); structural differences inshared(types-only) andxerbla(LAPACK error handler) — intentional special-purpose packages.lapack/base/clacgvThe README was missing the
## C APIsplaceholder section present in 26 of 30lapack/basepackages (87% conformance). The standard placeholder block was inserted between<!-- /.examples -->and theRelated stdlib packagescomment, matching the byte-identical template used byclaset,claswp,zlacpy,zlaset, and 22 other siblings. Net change is +70 lines, README only.lapack/base/crotAdds the missing
## C APIsplaceholder section to the README. The section is absent in 4 of 30lapack/basepackages (87% conformance); this patch bringscrotin line with the other 26. Inserted between<!-- /.examples -->and theRelated stdlib packagescomment, byte-identical to the standard template. No code or test changes.lapack/base/zlacgvThe README was missing the
## C APIsplaceholder section present in 26 of 30lapack/basepackages (87% conformance). The standard placeholder block was inserted between<!-- /.examples -->and theRelated stdlib packagescomment. Change is +70 lines, README only.lapack/base/zrotThe README for
@stdlib/lapack/base/zrotis missing the## C APIsplaceholder section present in 26 of 30lapack/basepackages (87% conformance). The fix inserts the standard C APIs placeholder block between<!-- /.examples -->and theRelated stdlib packagescomment. The change is +70 lines, README-only, with no code or test modifications.Related Issues
None.
Questions
No.
Other
Validation
package.jsonkeys, README section lists,manifest.jsonshape,test//benchmark//examples/file naming).xerbla) and JSDoc shape (JSDoc lives on per-function files, notmain.js).confirmed-driftfor the four outliers; the inserted block was verified byte-identical to four reference packages (claset,claswp,zlacpy,zlaset).Deliberate exclusions
sharedandxerblaare excluded from drift corrections (special-purpose packages —sharedexports include-path metadata;xerblais the LAPACK error handler).dlamch,dlapy2,dlapy3are excluded from "missing ndarray variant" findings (these operate on scalars and legitimately lack array variants).lib/base.jswas not propagated to the 4 outliers — its presence reflects 2D matrix-layout factoring, not a universal convention, and adding it would constitute a refactor rather than a mechanical drift correction.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was prepared by Claude Code as a cross-package drift detection run over the
@stdlib/lapack/basenamespace. Claude extracted structural and semantic features across all 30 packages, computed majority conformance per feature, applied three-agent validation to the surfaced outliers, and inserted a byte-identical placeholder template into the four outliers' READMEs. The inserted block matches the standard already used by 26 sibling packages — no code, tests, or examples were modified.Generated by Claude Code