docs: remove unnecessary require statements - #14856
Merged
Merged
Conversation
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`).
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
September 1, 2026 10:09
kgryte
approved these changes
Sep 1, 2026
blas/ext/base/wasm/dasumpw and blas/ext/base/wasm/dnansumkbn2 examples
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 removes a redundant
requirestatement from the JSDoc@exampleblocks in two@stdlib/blas/ext/base/wasmpackages 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-requirethemselves — a line absent from every other package in the namespace and from all packages in the mature@stdlib/blas/base/wasmsibling namespace. The examples now require only@stdlib/array/float64. Conformance to the majority convention: 8 of 10 namespace packages; 33 of 33blas/base/wasmpackages.blas/ext/base/wasm/dasumpwRemoved the
require( '@stdlib/blas/ext/base/wasm/dasumpw' )line from both@exampleblocks inlib/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/dnansumkbn2Removed the
require( '@stdlib/blas/ext/base/wasm/dnansumkbn2' )line from both@exampleblocks inlib/main.js. Documentation-only; the exported API and behavior are unchanged.Related Issues
None.
Questions
No.
Other
The change is documentation-only and confined to JSDoc
@examplecomments; 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
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
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/wasmnamespace, identified the majority@exampleconvention, 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