Skip to content

Commit 3e6159b

Browse files
committed
docs: resolve doctest errors in TSDoc
--- 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 8b0b780 commit 3e6159b

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

lib/node_modules/@stdlib/assert/is-nonnegative-number-array/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ interface IsNonNegativeNumberArray {
9393
* var bool = isNonNegativeNumberArray.objects( [ new Number(3.0), new Number(1.0) ] );
9494
* // returns true
9595
*/
96-
declare var isnonnegativeNumberArray: IsNonNegativeNumberArray;
96+
declare var isNonNegativeNumberArray: IsNonNegativeNumberArray;
9797

9898

9999
// EXPORTS //
100100

101-
export = isnonnegativeNumberArray;
101+
export = isNonNegativeNumberArray;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@
3535
* @example
3636
* var sqrt = require( '@stdlib/math/base/special/sqrt' );
3737
*
38-
* var v = asindf( sqrt( 2.0 ) / 2.0 );
38+
* var v = asind( sqrt( 2.0 ) / 2.0 );
3939
* // returns ~45.0
4040
*
4141
* @example
4242
* var sqrt = require( '@stdlib/math/base/special/sqrt' );
4343
*
44-
* var v = asindf( sqrt( 3.0 ) / 2.0 );
44+
* var v = asind( sqrt( 3.0 ) / 2.0 );
4545
* // returns ~60.0
4646
*
4747
* @example

lib/node_modules/@stdlib/math/base/special/fast/alpha-max-plus-beta-min/docs/types/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ interface Hypot {
3939
* @returns hypotenuse
4040
*
4141
* @example
42-
* var h = ampbm( -5.0, 12.0 );
42+
* var h = hypot( -5.0, 12.0 );
4343
* // returns ~13.5
4444
*/
4545
( x: number, y: number ): number;
@@ -54,10 +54,10 @@ interface Hypot {
5454
* @returns function to compute a hypotenuse
5555
*
5656
* @example
57-
* var hypot = ampbm.factory( 1.0, 0.5 );
57+
* var fcn = hypot.factory( 1.0, 0.5 );
5858
* // returns <Function>
5959
*
60-
* var h = hypot( -5.0, 12.0 );
60+
* var h = fcn( -5.0, 12.0 );
6161
* // returns 14.5
6262
*/
6363
factory( alpha: number, beta: number, nonnegative?: boolean, ints?: boolean ): HypotFunction;
@@ -71,14 +71,14 @@ interface Hypot {
7171
* @returns hypotenuse
7272
*
7373
* @example
74-
* var h = ampbm( -5.0, 12.0 );
74+
* var h = hypot( -5.0, 12.0 );
7575
* // returns ~13.5
7676
*
7777
* @example
78-
* var hypot = ampbm.factory( 1.0, 0.5 );
78+
* var fcn = hypot.factory( 1.0, 0.5 );
7979
* // returns <Function>
8080
*
81-
* var h = hypot( -5.0, 12.0 );
81+
* var h = fcn( -5.0, 12.0 );
8282
* // returns 14.5
8383
*/
8484
declare var hypot: Hypot;

lib/node_modules/@stdlib/simulate/iter/cosine-wave/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ interface Options {
8484
* // returns 0.0
8585
*
8686
* v = iter.next().value;
87-
* // returns 1.0
87+
* // returns -1.0
8888
*
8989
* // ...
9090
*/

lib/node_modules/@stdlib/simulate/iter/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ interface Namespace {
265265
* // returns 0.0
266266
*
267267
* v = iter.next().value;
268-
* // returns 1.0
268+
* // returns -1.0
269269
*
270270
* // ...
271271
*/

0 commit comments

Comments
 (0)