Skip to content

Commit 14c1c5e

Browse files
committed
docs: improve doctests for complex number instances in math/base/special/cflipsignf
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 0d997c7 commit 14c1c5e

File tree

1 file changed

+1
-9
lines changed
  • lib/node_modules/@stdlib/math/base/special/cflipsignf

1 file changed

+1
-9
lines changed

lib/node_modules/@stdlib/math/base/special/cflipsignf/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,9 @@ Returns a single-precision complex floating-point number with the same magnitude
4646

4747
```javascript
4848
var Complex64 = require( '@stdlib/complex/float32/ctor' );
49-
var real = require( '@stdlib/complex/float32/real' );
50-
var imag = require( '@stdlib/complex/float32/imag' );
5149

5250
var v = cflipsignf( new Complex64( -4.0, 5.0 ), -1.0 );
53-
// returns <Complex64>
54-
55-
var re = real( v );
56-
// returns 4.0
57-
58-
var im = imag( v );
59-
// returns -5.0
51+
// returns <Complex64>[ 4.0, -5.0 ]
6052
```
6153

6254
</section>

0 commit comments

Comments
 (0)