Skip to content

Commit

Permalink
docs: fix docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
steff456 committed Jul 21, 2023
1 parent 87dd71f commit 80ea3c0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,33 +47,33 @@ var WORKSPACE = [ 0.0, 0.0 ];
* var imag = require( '@stdlib/complex/imag' );
*
* var z = new Complex128( 0.0, 0.0 );
* // throws { 're': 0, 'im': 0 }
* // returns { 're': 0.0, 'im': 0.0 }
*
* var out = ccis( z );
* // throws { 're': 1, 'im': 0 }
* // returns { 're': 1.0, 'im': 0.0 }
*
* var re = real( out );
* // throws 1
* // returns 1.0
*
* var im = imag( out );
* // throws 0
* // returns 0.0
*
* @example
* var Complex128 = require( '@stdlib/complex/float64' );
* var real = require( '@stdlib/complex/real' );
* var imag = require( '@stdlib/complex/imag' );
*
* var z = new Complex128( 1.0, 0.0 );
* // throws { 're': 1, 'im': 0 }
* // returns { 're': 1.0, 'im': 0.0 }
*
* var out = ccis( z );
* // throws { 're': ~0.54, 'im': ~0.841 }
* // returns { 're': ~0.54, 'im': ~0.841 }
*
* var re = real( out );
* // throws ~0.54
* // returns ~0.54
*
* var im = imag( out );
* // throws ~0.841
* // returns ~0.841
*/
function ccis( z ) {
var re;
Expand Down

0 comments on commit 80ea3c0

Please sign in to comment.