Skip to content

Commit a76d474

Browse files
authored
docs: update math/base/special TypeScript declaration example code
PR-URL: #9794 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent be2d13e commit a76d474

1 file changed

Lines changed: 3 additions & 27 deletions

File tree

  • lib/node_modules/@stdlib/math/base/special/docs/types

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

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2831,31 +2831,15 @@ interface Namespace {
28312831
*
28322832
* @example
28332833
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2834-
* var real = require( '@stdlib/complex/float64/real' );
2835-
* var imag = require( '@stdlib/complex/float64/imag' );
28362834
*
28372835
* var v = ns.cexp( new Complex128( 0.0, 0.0 ) );
2838-
* // returns <Complex128>
2839-
*
2840-
* var re = real( v );
2841-
* // returns 1.0
2842-
*
2843-
* var im = imag( v );
2844-
* // returns 0.0
2836+
* // returns <Complex128>[ 1.0, 0.0 ]
28452837
*
28462838
* @example
28472839
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2848-
* var real = require( '@stdlib/complex/float64/real' );
2849-
* var imag = require( '@stdlib/complex/float64/imag' );
28502840
*
28512841
* var v = ns.cexp( new Complex128( 1.0, 0.0 ) );
2852-
* // returns <Complex128>
2853-
*
2854-
* var re = real( v );
2855-
* // returns ~2.718
2856-
*
2857-
* var im = imag( v );
2858-
* // returns 0.0
2842+
* // returns <Complex128>[ ~2.718, 0.0 ]
28592843
*/
28602844
cexp: typeof cexp;
28612845

@@ -2905,17 +2889,9 @@ interface Namespace {
29052889
*
29062890
* @example
29072891
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2908-
* var real = require( '@stdlib/complex/float64/real' );
2909-
* var imag = require( '@stdlib/complex/float64/imag' );
29102892
*
29112893
* var v = ns.cfloor( new Complex128( 5.5, 3.3 ) );
2912-
* // returns <Complex128>
2913-
*
2914-
* var re = real( v );
2915-
* // returns 5.0
2916-
*
2917-
* var im = imag( v );
2918-
* // returns 3.0
2894+
* // returns <Complex128>[ 5.0, 3.0 ]
29192895
*/
29202896
cfloor: typeof cfloor;
29212897

0 commit comments

Comments
 (0)