docs: add C APIs section placeholder to four lapack/base packages#12879
Draft
Planeshifter wants to merge 4 commits into
Draft
docs: add C APIs section placeholder to four lapack/base packages#12879Planeshifter wants to merge 4 commits into
C APIs section placeholder to four lapack/base packages#12879Planeshifter wants to merge 4 commits into
Conversation
Added a `## C APIs` section to README.md matching the canonical placeholder stub used elsewhere in `lapack/base` (present in 27/31 packages = 87%). The stub is identical to the boilerplate already in `lapack/base/dgttrf`, `lapack/base/dladiv`, `lapack/base/dlassq`, and others. No functional or public-API change.
Added a `## C APIs` section to README.md matching the canonical placeholder stub used elsewhere in `lapack/base` (present in 27/31 packages = 87%). The stub is identical to the boilerplate already in `lapack/base/dgttrf`, `lapack/base/dladiv`, `lapack/base/dlassq`, and others. No functional or public-API change.
Added a `## C APIs` section to README.md matching the canonical placeholder stub used elsewhere in `lapack/base` (present in 27/31 packages = 87%). The stub is identical to the boilerplate already in `lapack/base/dgttrf`, `lapack/base/dladiv`, `lapack/base/dlassq`, and others. No functional or public-API change.
Added a `## C APIs` section to README.md matching the canonical placeholder stub used elsewhere in `lapack/base` (present in 27/31 packages = 87%). The stub is identical to the boilerplate already in `lapack/base/dgttrf`, `lapack/base/dladiv`, `lapack/base/dlassq`, and others. No functional or public-API change.
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 inserts the canonical
## C APIsplaceholder section into fourlapack/basepackages whose READMEs currently skip the section:clacgv,crot,zlacgv, andzrot. The stub is byte-identical to the boilerplate already used by 27/31 (≈87%) siblings, includingdgttrf,dladiv,dlassq,slaswp,iladlc, anddlapy2. No JavaScript, tests, examples, or public API are touched.The four outliers are all valid LAPACK BLAS-like routines whose Fortran counterparts exist upstream; like most siblings, none ships a native binding today, but the placeholder is the documented convention for the namespace and keeps the namespace consistent for future C-bridge work.
Namespace summary
@stdlib/lapack/base## C APIsplaceholder section (27/31 = 87%),## Usage,## Notes,## Examples,### Usage,### Examples,examples/index.js, top-levelpackage.jsonkeys,test/test.js,benchmark/benchmark.js.binding.gyp,include.gypi,src/,manifest.json— only 2-3/31 packages),lib/native.js(1/31),package.jsonkeywordsarrays (heterogeneous by routine type).Per outlier package
lapack/base/clacgvAdds the standard
## C APIsplaceholder section (27/31 = 87% of siblings). The README previously jumped from<!-- /.examples -->directly to the auto-populated<section class="related">, skipping the stub used by every other complex/single-precision routine in the namespace that has a C-bridge stub queued. Stub content is identical tolapack/base/dgttrf; no signature, behavior, or test surface changes.lapack/base/crotAdds the standard
## C APIsplaceholder section (27/31 = 87% of siblings).crotis the single-precision complex plane-rotation routine; like its real-precision siblings, it now carries the placeholder TODO stub in preparation for a future C bridge. Stub content is byte-identical to the canonical boilerplate.lapack/base/zlacgvAdds the standard
## C APIsplaceholder section (27/31 = 87% of siblings).zlacgvis the double-precision complex counterpart ofclacgv; the omission mirroredclacgv's and is corrected for consistency. Stub content is byte-identical to the canonical boilerplate.lapack/base/zrotAdds the standard
## C APIsplaceholder section (27/31 = 87% of siblings).zrotis the double-precision complex counterpart ofcrot; the omission mirroredcrot's. Stub content is byte-identical to the canonical boilerplate.Related Issues
None.
Questions
No.
Other
Validation
package.jsonshapes, README heading lists,manifest.jsonshapes, and test/benchmark/example file names were extracted across all 31 members of@stdlib/lapack/base.lib/main.jsand the routine-named entry (e.g.lib/clacgv.js) of each outlier were inspected to confirm structural parity with majority-pattern siblings (setReadOnly-wrappedndarrayattachment, identical export shape).## C APIsanchor or content of these packages; structural review confirmed the stub is character-for-character identical across the 27 conforming siblings sampled.## C APIsheadings present in the 27 conforming packages were not modified.src/,include/,binding.gyp,manifest.json) andlib/native.jswere not added — only 1-3 packages in the namespace currently have these, so absence is not drift.## Notesis missing fromxerblaandshared, but those packages are an error handler and an internal include-path helper respectively (intentional deviation from the routine pattern); excluded.test.ndarray.js/benchmark.ndarray.jsare absent fromdlaisnan,dlamch,dlapy2,dlapy3,xerbla,shared— these are scalar/utility packages without an ndarray API, so absence is intentional.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code running the cross-package drift-detection routine. The routine extracted structural features from all 31
@stdlib/lapack/basepackages, identified that 27/31 (87%) include a placeholder## C APIsREADME section, flagged the four outliers (clacgv,crot,zlacgv,zrot), ran a three-agent validation gate (semantic review, cross-reference review, and structural review) which independently confirmed advance, and inserted the canonical placeholder stub byte-identically into each. The inserted text is unchanged boilerplate (no AI-generated technical content). A maintainer should promote out of draft.@stdlib-js/reviewers
Generated by Claude Code