docs: add missing intro section placeholders#12623
Merged
Merged
Conversation
Add empty `<section class="intro">` placeholder between the description blockquote and the usage section, matching the convention used by 37 of the 40 packages in `blas/base/ndarray/` (92.5% conformance). The placeholder is also present in 100% of `blas/ext/base/ndarray/` siblings and in the `srot` package being added in open PR #12510, confirming the convention is current.
Add empty `<section class="intro">` placeholder between the description blockquote and the usage section, matching the convention used by 37 of the 40 packages in `blas/base/ndarray/` (92.5% conformance). The placeholder is also present in 100% of `blas/ext/base/ndarray/` siblings and in the `srot` package being added in open PR #12510, confirming the convention is current.
Add empty `<section class="intro">` placeholder between the description blockquote and the usage section, matching the convention used by 37 of the 40 packages in `blas/base/ndarray/` (92.5% conformance). The placeholder is also present in 100% of `blas/ext/base/ndarray/` siblings and in the `srot` package being added in open PR #12510, confirming the convention is current.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jun 6, 2026
blas/base/ndarray/i{d,g,s}amax
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:
<section class="intro">placeholder block inblas/base/ndarray/idamax,blas/base/ndarray/igamax, andblas/base/ndarray/isamaxREADMEs, bringing them in line with the rest of the namespace.Namespace summary
@stdlib/blas/base/ndarraypackage.jsonshape (top-level keys,scripts,keywords,directories,engines,os, dependencies),manifest.jsonshape, README section sequence (HTML<section>boundaries,##/###headings),test/,benchmark/,examples/filenames,lib/main.jsJSDoc tag shape, signature,require()set, and error-construction patterns.package.jsontop-level keys (100%),engines/os/directories/main/types/bugs/homepage(100% identical), 11 canonical keywords (100%:stdlib,stdmath,mathematics,math,blas,level 1,linear,algebra,subroutines,vector,ndarray), README## Usage/## ExamplesH2 sequence (100%), README HTML section sequenceintro→usage→notes→examples→related→links(92.5%),lib/main.jsJSDoc tags(license, param, returns, example)(100%),lib/main.jssignature<pkg>( arrays )(100%), 4 canonicalrequire()s from@stdlib/ndarray/base/{numel-dimension,stride,offset,data-buffer}(100%),index.jsdescription prefixBLAS level 1 routine to …(100%).arraykeyword (22/40 = 55% — semantically split between scal/copy/swap/axpy and reduce/scan operations),ndarraylike2scalarrequire (32% — only when a scalar argument is unpacked), per-package equation<!-- <equation -->blocks (varies by math).blas/base/ndarray/idamaxidamaxis one of three outliers (idamax,igamax,isamax) missing the empty<section class="intro">placeholder between the description blockquote and the usage section. 37 of the 40 namespace siblings carry the placeholder — 92.5% conformance — and the recently-openedsrotpackage (PR #12510) adds it too, so the convention is current, not legacy. The fix is a six-line markdown insertion; no source or test change.blas/base/ndarray/igamaxSame drift as
idamax: the README jumps directly from the description blockquote to<section class="usage">, omitting the empty intro placeholder. The generic-typedg*sibling line (gasum,gaxpy,gcopy,gdot,gnrm2,gscal,gswap) all carry it. Mechanical six-line insertion.blas/base/ndarray/isamaxSame drift as
idamaxandigamax. The single-precisions*siblings (sasum,saxpy,sdot,snrm2,sscal,sswap, etc.) all carry the placeholder. Mechanical six-line insertion.Validation
Checked:
package.jsonkeys/values,manifest.jsonkeys where present, README HTML section sequence, README##/###heading sequence, test/benchmark/example filenames).lib/main.jssource scan: signature shape, JSDoc tags, require set,throw/formatpresence (none in this namespace — base wrappers have no validation prologue).confirmed-driftfor each of the three outliers.srot(feat: addblas/base/ndarray/srot#12510) anddrot(feat: addblas/base/ndarray/drot#12456) PRs add new packages and do not touch the three outliers' READMEs.Deliberately excluded:
Copyright (c) 2025(ddot,gdot,sdot) — copyright year reflects file-creation year by stdlib convention, not staleness; not drift.arraykeyword distribution (22/40 = 55%) — semantically split between in-place vector ops and reductions; below the 75% threshold and the split is not random.<!-- <equation -->blocks inside the intro section — content is mathematics-specific (L1-norm, L2-norm, dot product) and not a structural drift.Related Issues
None.
Questions
No.
Other
Generated by an automated cross-package drift-detection run (random-pick namespace selection; full per-feature distribution and dropped-candidate log live in the local report). The diff is mechanical: three READMEs gain six lines each of empty markdown placeholder; no source, test, or example file is touched; no observable behavior changes.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated cross-package drift-detection routine. The drift was identified by structural feature extraction across
@stdlib/blas/base/ndarray/; the proposed fix was validated by parallel semantic, cross-reference, and structural-review subagents (all returnedconfirmed-drift); the patch is a six-line markdown insertion in each of the three outlier READMEs.@stdlib-js/reviewers
Generated by Claude Code