Skip to content

docs: fix examples and notes #16144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 3 commits into from
Oct 14, 2026
+2 −6
Merged

docs: fix examples and notes #16144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26341f0
docs: remove unused `Uint64` require in `array/uint64` examples
claude Oct 14, 2026
fea10eb
docs: fix prepend/append description in `blas/ext/base/ndarray/gediff`
claude Oct 14, 2026
45e6c04
chore: restore `array/uint64` TypeScript declarations
claude Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/array/uint64/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,6 @@ u = arr.at( -100 );
Returns an iterator for iterating over array key-value pairs.

```javascript
var Uint64 = require( '@stdlib/number/uint64/ctor' );

var arr = new Uint64Array( [ 1, 2, 3 ] );

// Create an iterator:
Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/array/uint64/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,8 +607,6 @@
* @returns {Iterator} iterator
*
* @example
* var Uint64 = require( '@stdlib/number/uint64/ctor' );
*
* var arr = new Uint64Array( [ 1, 2, 3 ] );
*
* // Create an iterator:
Expand Down Expand Up @@ -841,7 +839,7 @@
buf[ idx+indices.LOW ] = words[ 1 ];
return;
}
if ( isNonNegativeInteger( value ) || ( isBigInt( value ) && isNonNegativeInteger( Number( value ) ) ) ) {

Check warning on line 842 in lib/node_modules/@stdlib/array/uint64/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

This line has a length of 110. Maximum allowed is 80
if ( idx >= this._length ) {
throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%u`.', idx ) );
}
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gediff/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ The function has the following parameters:
- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a one-dimensional ndarray containing values to prepend prior to computing differences.
- a one-dimensional ndarray containing values to append prior to computing differences.
- a one-dimensional ndarray containing values to prepend after computing differences.
- a one-dimensional ndarray containing values to append after computing differences.
- a one-dimensional output ndarray. Must have `N + N1 + N2 - 1` elements, where `N` is the number of elements in the input ndarray, `N1` is the number of elements to prepend, and `N2` is the number of elements to append.

</section>
Expand Down
Loading