Skip to content

Commit 2cf7f78

Browse files
committed
docs: correct function names, return values, and method calls in TypeScript declaration examples
--- 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: na - 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 4fadd45 commit 2cf7f78

File tree

9 files changed

+19
-18
lines changed

9 files changed

+19
-18
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* @example
2828
* var v = acosd( 0.0 );
29-
* // returns 0.0
29+
* // returns 90.0
3030
*
3131
* @example
3232
* var v = acosd( 0.5 );

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* @example
2828
* var v = acosdf( 0.0 );
29-
* // returns 0.0
29+
* // returns 90.0
3030
*
3131
* @example
3232
* var v = acosdf( 0.5 );

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* @example
2828
* var v = acsch( 0 );
29-
* // returns NaN
29+
* // returns Infinity
3030
*
3131
* @example
3232
* var v = acsch( -1.0 );

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ import { Complex128 } from '@stdlib/types/complex';
4444
*
4545
* var im = imag( out );
4646
* // returns 0.0
47+
*
4748
* @example
4849
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
4950
* var real = require( '@stdlib/complex/float64/real' );
@@ -61,9 +62,9 @@ import { Complex128 } from '@stdlib/types/complex';
6162
* var im = imag( out );
6263
* // returns ~0.841
6364
*/
64-
declare function cis( z: Complex128 ): Complex128;
65+
declare function ccis( z: Complex128 ): Complex128;
6566

6667

6768
// EXPORTS //
6869

69-
export = cis;
70+
export = ccis;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import { Complex128 } from '@stdlib/types/complex';
3434
* var real = require( '@stdlib/complex/float64/real' );
3535
* var imag = require( '@stdlib/complex/float64/imag' );
3636
*
37-
* var v = cfloor( new Complex128( 5.555, -3.333 ), -2 );
37+
* var v = cfloorn( new Complex128( 5.555, -3.333 ), -2 );
3838
* // returns <Complex128>
3939
*
4040
* var re = real( v );

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import { Complex128 } from '@stdlib/types/complex';
3333
* var real = require( '@stdlib/complex/float64/real' );
3434
* var imag = require( '@stdlib/complex/float64/imag' );
3535
*
36-
* var v = cceil( new Complex128( -4.2, 5.5 ) );
36+
* var v = cround( new Complex128( -4.2, 5.5 ) );
3737
* // returns <Complex128>
3838
*
3939
* var re = real( v );

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ import { Complex128 } from '@stdlib/types/complex';
3838
* var real = require( '@stdlib/complex/float64/real' );
3939
* var imag = require( '@stdlib/complex/float64/imag' );
4040
*
41-
* var v = cceil( new Complex128( 5.555, -3.333 ) );
41+
* var v = croundn( new Complex128( 5.555, -3.333 ), -2 );
4242
* // returns <Complex128>
4343
*
4444
* var re = real( v );
4545
* // returns 5.56
4646
*
4747
* var im = imag( v );
48-
* // returns -3.34
48+
* // returns -3.33
4949
*/
5050
declare function croundn( z: Complex128, n: number ): Complex128;
5151

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
*
3636
* @example
3737
* var v = fmodf( 8.9, 3.0 );
38-
* // returns 2.9
38+
* // returns ~2.9
3939
*
4040
* @example
4141
* var v = fmodf( NaN, 3.0 );

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,8 @@ interface MinMaxAbsN {
148148
*
149149
* @example
150150
* var out = [ 0.0, 0.0 ];
151-
* var v = minmaxabsn( out, 1, 0 );
152-
* // returns [ Infinity, -Infinity ]
151+
* var v = minmaxabsn.assign( out, 1, 0 );
152+
* // returns [ Infinity, Infinity ]
153153
*
154154
* var bool = ( v === out );
155155
* // returns true
@@ -167,7 +167,7 @@ interface MinMaxAbsN {
167167
*
168168
* @example
169169
* var out = [ 0.0, 0.0 ];
170-
* var v = minmaxabsn( 3.14, out, 1, 0 );
170+
* var v = minmaxabsn.assign( 3.14, out, 1, 0 );
171171
* // returns [ 3.14, 3.14 ]
172172
*
173173
* var bool = ( v === out );
@@ -187,7 +187,7 @@ interface MinMaxAbsN {
187187
*
188188
* @example
189189
* var out = [ 0.0, 0.0 ];
190-
* var v = minmaxabsn( 3.14, -8.0, out, 1, 0 );
190+
* var v = minmaxabsn.assign( 3.14, -8.0, out, 1, 0 );
191191
* // returns [ 3.14, 8.0 ]
192192
*
193193
* var bool = ( v === out );
@@ -208,7 +208,7 @@ interface MinMaxAbsN {
208208
*
209209
* @example
210210
* var out = [ 0.0, 0.0 ];
211-
* var v = minmaxabsn( 3.14, -8.0, 6.5, out, 1, 0 );
211+
* var v = minmaxabsn.assign( 3.14, -8.0, 6.5, out, 1, 0 );
212212
* // returns [ 3.14, 8.0 ]
213213
*
214214
* var bool = ( v === out );
@@ -230,7 +230,7 @@ interface MinMaxAbsN {
230230
*
231231
* @example
232232
* var out = [ 0.0, 0.0 ];
233-
* var v = minmaxabsn( 3.14, -8.0, 6.5, 7.2, out, 1, 0 );
233+
* var v = minmaxabsn.assign( 3.14, -8.0, 6.5, 7.2, out, 1, 0 );
234234
* // returns [ 3.14, 8.0 ]
235235
*
236236
* var bool = ( v === out );
@@ -253,7 +253,7 @@ interface MinMaxAbsN {
253253
*
254254
* @example
255255
* var out = [ 0.0, 0.0 ];
256-
* var v = minmaxabsn( 3.14, -8.0, 6.5, 7.2, 5.2, out, 1, 0 );
256+
* var v = minmaxabsn.assign( 3.14, -8.0, 6.5, 7.2, 5.2, out, 1, 0 );
257257
* // returns [ 3.14, 8.0 ]
258258
*
259259
* var bool = ( v === out );
@@ -274,7 +274,7 @@ interface MinMaxAbsN {
274274
*
275275
* @example
276276
* var out = [ 0.0, 0.0 ];
277-
* var v = minmaxabsn( 3.14, -8.0, 6.5, 7.2, 5.2, -5.4, out, 1, 0 );
277+
* var v = minmaxabsn.assign( 3.14, -8.0, 6.5, 7.2, 5.2, -5.4, out, 1, 0 );
278278
* // returns [ 3.14, 8.0 ]
279279
*
280280
* var bool = ( v === out );

0 commit comments

Comments
 (0)