Skip to content

Commit cd063e0

Browse files
authored
docs: update examples
PR-URL: #9036 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 07f9e6e commit cd063e0

File tree

1 file changed

+3
-25
lines changed
  • lib/node_modules/@stdlib/math/base/special/docs/types

1 file changed

+3
-25
lines changed

lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2964,17 +2964,9 @@ interface Namespace {
29642964
*
29652965
* @example
29662966
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2967-
* var real = require( '@stdlib/complex/float64/real' );
2968-
* var imag = require( '@stdlib/complex/float64/imag' );
29692967
*
29702968
* var v = ns.cinv( new Complex128( 2.0, 4.0 ) );
2971-
* // returns <Complex128>
2972-
*
2973-
* var re = real( v );
2974-
* // returns 0.1
2975-
*
2976-
* var im = imag( v );
2977-
* // returns -0.2
2969+
* // returns <Complex128>[ ~0.1, ~-0.2 ]
29782970
*/
29792971
cinv: typeof cinv;
29802972

@@ -2986,17 +2978,9 @@ interface Namespace {
29862978
*
29872979
* @example
29882980
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
2989-
* var realf = require( '@stdlib/complex/float32/real' );
2990-
* var imagf = require( '@stdlib/complex/float32/imag' );
29912981
*
29922982
* var v = ns.cinvf( new Complex64( 2.0, 4.0 ) );
2993-
* // returns <Complex64>
2994-
*
2995-
* var re = realf( v );
2996-
* // returns ~0.1
2997-
*
2998-
* var im = imagf( v );
2999-
* // returns ~-0.2
2983+
* // returns <Complex64>[ ~0.1, ~-0.2 ]
30002984
*/
30012985
cinvf: typeof cinvf;
30022986

@@ -3648,13 +3632,7 @@ interface Namespace {
36483632
* var imag = require( '@stdlib/complex/float64/imag' );
36493633
*
36503634
* var v = ns.cround( new Complex128( -4.2, 5.5 ) );
3651-
* // returns <Complex128>
3652-
*
3653-
* var re = real( v );
3654-
* // returns -4.0
3655-
*
3656-
* var im = imag( v );
3657-
* // returns 6.0
3635+
* // returns <Complex128>[ -4.0, 6.0 ]
36583636
*/
36593637
cround: typeof cround;
36603638

0 commit comments

Comments
 (0)