Skip to content

Commit 4e6ab18

Browse files
authored
docs: update examples
PR-URL: #9204 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent de9dec4 commit 4e6ab18

File tree

1 file changed

+10
-40
lines changed
  • lib/node_modules/@stdlib/stats/docs/types

1 file changed

+10
-40
lines changed

lib/node_modules/@stdlib/stats/docs/types/index.d.ts

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -456,10 +456,7 @@ interface Namespace {
456456
* var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
457457
*
458458
* var y = ns.mean( x );
459-
* // returns <ndarray>
460-
*
461-
* var v = y.get();
462-
* // returns 1.25
459+
* // returns <ndarray>[ 1.25 ]
463460
*
464461
* @example
465462
* var array = require( '@stdlib/ndarray/array' );
@@ -469,10 +466,7 @@ interface Namespace {
469466
* var y = zeros( [] );
470467
*
471468
* var out = ns.mean.assign( x, y );
472-
* // returns <ndarray>
473-
*
474-
* var v = out.get();
475-
* // returns 1.25
469+
* // returns <ndarray>[ 1.25 ]
476470
*
477471
* var bool = ( out === y );
478472
* // returns true
@@ -492,10 +486,7 @@ interface Namespace {
492486
* var x = array( [ -1.0, 2.0, -3.0 ] );
493487
*
494488
* var y = ns.min( x );
495-
* // returns <ndarray>
496-
*
497-
* var v = y.get();
498-
* // returns -3.0
489+
* // returns <ndarray>[ -3.0 ]
499490
*
500491
* @example
501492
* var array = require( '@stdlib/ndarray/array' );
@@ -505,10 +496,7 @@ interface Namespace {
505496
* var y = zeros( [] );
506497
*
507498
* var out = ns.min.assign( x, y );
508-
* // returns <ndarray>
509-
*
510-
* var v = out.get();
511-
* // returns -3.0
499+
* // returns <ndarray>[ -3.0 ]
512500
*
513501
* var bool = ( out === y );
514502
* // returns true
@@ -534,10 +522,7 @@ interface Namespace {
534522
* }
535523
*
536524
* var y = ns.minBy( x, clbk );
537-
* // returns <ndarray>
538-
*
539-
* var v = y.get();
540-
* // returns -6.0
525+
* // returns <ndarray>[ -6.0 ]
541526
*
542527
* @example
543528
* var array = require( '@stdlib/ndarray/array' );
@@ -551,10 +536,7 @@ interface Namespace {
551536
* }
552537
*
553538
* var out = ns.minBy.assign( x, y, clbk );
554-
* // returns <ndarray>
555-
*
556-
* var v = out.get();
557-
* // returns -6.0
539+
* // returns <ndarray>[ -6.0 ]
558540
*
559541
* var bool = ( out === y );
560542
* // returns true
@@ -574,10 +556,7 @@ interface Namespace {
574556
* var x = array( [ -1.0, 2.0, -3.0 ] );
575557
*
576558
* var y = ns.minabs( x );
577-
* // returns <ndarray>
578-
*
579-
* var v = y.get();
580-
* // returns 1.0
559+
* // returns <ndarray>[ 1.0 ]
581560
*
582561
* @example
583562
* var array = require( '@stdlib/ndarray/array' );
@@ -587,10 +566,7 @@ interface Namespace {
587566
* var y = zeros( [] );
588567
*
589568
* var out = ns.minabs.assign( x, y );
590-
* // returns <ndarray>
591-
*
592-
* var v = out.get();
593-
* // returns 1.0
569+
* // returns <ndarray>[ 1.0]
594570
*
595571
* var bool = ( out === y );
596572
* // returns true
@@ -610,10 +586,7 @@ interface Namespace {
610586
* var x = array( [ -1.0, 2.0, NaN ] );
611587
*
612588
* var y = ns.nanmax( x );
613-
* // returns <ndarray>
614-
*
615-
* var v = y.get();
616-
* // returns 2.0
589+
* // returns <ndarray>[ 2.0 ]
617590
*
618591
* @example
619592
* var array = require( '@stdlib/ndarray/array' );
@@ -623,10 +596,7 @@ interface Namespace {
623596
* var y = zeros( [] );
624597
*
625598
* var out = ns.nanmax.assign( x, y );
626-
* // returns <ndarray>
627-
*
628-
* var v = out.get();
629-
* // returns 2.0
599+
* // returns <ndarray>[ 2.0 ]
630600
*
631601
* var bool = ( out === y );
632602
* // returns true

0 commit comments

Comments
 (0)