Skip to content

docs: remove unnecessary require statements - #14856

Merged
kgryte merged 2 commits into
developfrom
philipp/drift-blas-ext-base-wasm-2026-08-31
Sep 1, 2026
Merged

docs: remove unnecessary require statements#14856
kgryte merged 2 commits into
developfrom
philipp/drift-blas-ext-base-wasm-2026-08-31

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request removes a redundant require statement from the JSDoc @example blocks in two @stdlib/blas/ext/base/wasm packages so their documentation matches the established namespace convention.

Both packages document the exported routine via @name/@type {Routine} and reference the symbol directly in each @example, yet also re-require themselves — a line absent from every other package in the namespace and from all packages in the mature @stdlib/blas/base/wasm sibling namespace. The examples now require only @stdlib/array/float64. Conformance to the majority convention: 8 of 10 namespace packages; 33 of 33 blas/base/wasm packages.

blas/ext/base/wasm/dasumpw

Removed the require( '@stdlib/blas/ext/base/wasm/dasumpw' ) line from both @example blocks in lib/main.js. The routine symbol is already documented via @name/@type, so the self-require was redundant and inconsistent with the namespace.

blas/ext/base/wasm/dnansumkbn2

Removed the require( '@stdlib/blas/ext/base/wasm/dnansumkbn2' ) line from both @example blocks in lib/main.js. Documentation-only; the exported API and behavior are unchanged.

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

The change is documentation-only and confined to JSDoc @example comments; no source behavior, signatures, tests, or benchmarks are affected. These two packages were the only deviators in the namespace on this feature; the deviation was validated against sibling packages before applying the fix.

Checklist

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

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance.

This pull request was produced by Claude Code running an automated cross-package documentation drift-detection routine. Claude extracted structural and semantic documentation features across the blas/ext/base/wasm namespace, identified the majority @example convention, validated the two deviating packages against their siblings, and applied the mechanical removal. A maintainer reviews before merge.


@stdlib-js/reviewers


Generated by Claude Code

The `@example` blocks in `lib/main.js` included a redundant
`require( '@stdlib/blas/ext/base/wasm/dasumpw' )` statement that
deviated from the namespace convention. Sibling packages document the
routine via `@name`/`@type` and reference the symbol directly, requiring
only `@stdlib/array/float64`. Remove the extra require line so the
examples match the majority pattern (8 of 10 namespace packages; 33 of
33 in `blas/base/wasm`).
The `@example` blocks in `lib/main.js` included a redundant
`require( '@stdlib/blas/ext/base/wasm/dnansumkbn2' )` statement that
deviated from the namespace convention. Sibling packages document the
routine via `@name`/`@type` and reference the symbol directly, requiring
only `@stdlib/array/float64`. Remove the extra require line so the
examples match the majority pattern (8 of 10 namespace packages; 33 of
33 in `blas/base/wasm`).
@stdlib-bot stdlib-bot added the BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). label Aug 31, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/wasm/dasumpw $\\color{green}554/554$
$\\color{green}+100.00\\%$
$\\color{green}17/17$
$\\color{green}+100.00\\%$
$\\color{green}6/6$
$\\color{green}+100.00\\%$
$\\color{green}554/554$
$\\color{green}+100.00\\%$
blas/ext/base/wasm/dnansumkbn2 $\\color{green}545/545$
$\\color{green}+100.00\\%$
$\\color{green}17/17$
$\\color{green}+100.00\\%$
$\\color{green}6/6$
$\\color{green}+100.00\\%$
$\\color{green}545/545$
$\\color{green}+100.00\\%$

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

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Sep 1, 2026
@kgryte
kgryte marked this pull request as ready for review September 1, 2026 10:09
@kgryte
kgryte requested a review from a team September 1, 2026 10:09
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Sep 1, 2026
@kgryte kgryte changed the title docs: remove redundant require statements from blas/ext/base/wasm/dasumpw and blas/ext/base/wasm/dnansumkbn2 examples docs: remove unnecessary require statements Sep 1, 2026
@kgryte
kgryte merged commit 65754cb into develop Sep 1, 2026
66 checks passed
@kgryte
kgryte deleted the philipp/drift-blas-ext-base-wasm-2026-08-31 branch September 1, 2026 10:10
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants