Skip to content

docs: propagate fixes in TSDoc example code to namespace declarations #8126

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
merged 1 commit into from
Sep 22, 2025
Merged

docs: propagate fixes in TSDoc example code to namespace declarations #8126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 11 additions & 9 deletions lib/node_modules/@stdlib/array/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,7 +742,7 @@ interface Namespace {
* var x = [ 'beep', 'boop', 'foo', 'bar' ];
* var filter = [ true, true, false, true ];
*
* var out = ns.bifurcateEntries( arr, filter );
* var out = ns.bifurcateEntries( x, filter );
* // returns [ [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], [ [ 2, 'foo' ] ] ]
*/
bifurcateEntries: typeof bifurcateEntries;
Expand Down Expand Up @@ -822,7 +822,7 @@ interface Namespace {
* var x = [ 'beep', 'boop', 'foo', 'bar' ];
* var filter = [ true, true, false, true ];
*
* var out = ns.bifurcateValues( arr, filter );
* var out = ns.bifurcateValues( x, filter );
* // returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
*/
bifurcateValues: typeof bifurcateValues;
Expand Down Expand Up @@ -2138,16 +2138,16 @@ interface Namespace {
*
* @example
* function fcn( v ) {
* return v > 0;
* return v > 0;
* }
* var x = [ 1, 1, 0, 0, 0 ];
*
* var result = cunoneByright( x, fcn );
* var result = ns.cunoneByRight( x, fcn );
* // returns [ true, true, true, false, false ]
*
* @example
* function fcn( v ) {
* return v > 0;
* return v > 0;
* }
* var x = [ 0, 1, 1, 0, 0 ];
* var y = [ false, null, false, null, false, null, false, null, false, null ];
Expand Down Expand Up @@ -2734,7 +2734,7 @@ interface Namespace {
* @example
* var arr = [ 1, 2, 3 ];
*
* var out = ns.first( x );
* var out = ns.first( arr );
* // returns 1
*/
first: typeof first;
Expand Down Expand Up @@ -3537,7 +3537,7 @@ interface Namespace {
* @example
* var arr = [ 1, 2, 3 ];
*
* var out = ns.last( x );
* var out = ns.last( arr );
* // returns 3
*/
last: typeof last;
Expand Down Expand Up @@ -4014,7 +4014,7 @@ interface Namespace {
*
* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];
*
* mskbinary2d( [ x, y, mask, z ], shape, add );
* ns.mskbinary4d( [ x, y, mask, z ], shape, add );
*
* console.log( z );
* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ]
Expand Down Expand Up @@ -4946,6 +4946,8 @@ interface Namespace {
* @returns output array
*
* @example
* var isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive;
*
* var x = [ 1, -2, -3, 4 ];
*
* var out = ns.reject( x, isPositiveNumber );
Expand Down Expand Up @@ -5976,7 +5978,7 @@ interface Namespace {
* var x = ones5d( shape );
* var y = zeros5d( shape );
*
* unary2dBy( [ x, y ], shape, scale );
* ns.unary5dBy( [ x, y ], shape, scale );
*
* console.log( y );
* // => [ [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ] ]
Expand Down