Skip to content

Commit b44e0a7

Browse files
committed
docs: clean-up TSDoc 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 1891116 commit b44e0a7

File tree

12 files changed

+23
-23
lines changed

12 files changed

+23
-23
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ interface IsNonNegativeFinite {
6161
* @returns {boolean} boolean indicating if a value is a number primitive having a nonnegative finite value
6262
*
6363
* @example
64-
* var bool = isNonNegativeNumber( 3.0 );
64+
* var bool = isNonNegativeFinite( 3.0 );
6565
* // returns true
6666
*
6767
* @example
68-
* var bool = isNonNegativeNumber( new Number( 3.0 ) );
68+
* var bool = isNonNegativeFinite( new Number( 3.0 ) );
6969
* // returns false
7070
*
7171
* @example

lib/node_modules/@stdlib/assert/is-odd/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ interface IsOdd {
9898
* // returns true
9999
*
100100
* @example
101-
* var bool = isOdd( new Number( 6.0 ) );
101+
* var bool = isOdd( new Number( 5.0 ) );
102102
* // returns true
103103
*
104104
* @example
105-
* var bool = isOdd( 3.0 );
105+
* var bool = isOdd( 4.0 );
106106
* // returns false
107107
*
108108
* @example

lib/node_modules/@stdlib/constants/float16/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ interface Namespace {
5151
* Difference between one and the smallest value greater than one that can be represented as a half-precision floating-point number.
5252
*
5353
* @example
54-
* var eps = ns.EPSILON;
54+
* var eps = ns.EPS;
5555
* // returns 0.0009765625
5656
*/
5757
EPS: typeof EPS;
@@ -97,7 +97,7 @@ interface Namespace {
9797
*
9898
* @example
9999
* var ninf = ns.NINF;
100-
* // returns -infinity
100+
* // returns -Infinity
101101
*/
102102
NINF: typeof NINF;
103103

@@ -115,7 +115,7 @@ interface Namespace {
115115
*
116116
* @example
117117
* var pinf = ns.PINF;
118-
* // returns +infinity
118+
* // returns Infinity
119119
*/
120120
PINF: typeof PINF;
121121

lib/node_modules/@stdlib/constants/float16/ninf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*
2424
* @example
2525
* var ninf = FLOAT16_NINF;
26-
* // returns -infinity
26+
* // returns -Infinity
2727
*/
2828
declare const FLOAT16_NINF: number;
2929

lib/node_modules/@stdlib/constants/float32/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ interface Namespace {
258258
*
259259
* @example
260260
* var max = ns.MAX_SAFE_NTH_FACTORIAL;
261-
* // returns 34
261+
* // returns 10
262262
*/
263263
MAX_SAFE_NTH_FACTORIAL: typeof MAX_SAFE_NTH_FACTORIAL;
264264

@@ -339,7 +339,7 @@ interface Namespace {
339339
*
340340
* @example
341341
* var ninf = ns.NINF;
342-
* // returns -infinity
342+
* // returns -Infinity
343343
*/
344344
NINF: typeof NINF;
345345

@@ -375,7 +375,7 @@ interface Namespace {
375375
*
376376
* @example
377377
* var pinf = ns.PINF;
378-
* // returns +infinity
378+
* // returns Infinity
379379
*/
380380
PINF: typeof PINF;
381381

lib/node_modules/@stdlib/constants/float32/ln-sqrt-two-pi/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*
2424
* @example
2525
* var val = FLOAT32_LN_SQRT_TWO_PI;
26-
* // returns 0.9189385332046728
26+
* // returns 0.9189385175704956
2727
*/
2828
declare const FLOAT32_LN_SQRT_TWO_PI: number;
2929

lib/node_modules/@stdlib/constants/float32/ninf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*
2424
* @example
2525
* var ninf = FLOAT32_NINF;
26-
* // returns -infinity
26+
* // returns -Infinity
2727
*/
2828
declare const FLOAT32_NINF: number;
2929

lib/node_modules/@stdlib/constants/float32/pinf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*
2424
* @example
2525
* var pinf = FLOAT32_PINF;
26-
* // returns +infinity
26+
* // returns Infinity
2727
*/
2828
declare const FLOAT32_PINF: number;
2929

lib/node_modules/@stdlib/math/strided/special/dcbrt-by/docs/types/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ interface Routine {
128128
* return v;
129129
* }
130130
*
131-
* var x = Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
132-
* var out = Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
131+
* var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
132+
* var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
133133
*
134134
* dcbrtBy.ndarray( x.length, x, 1, 0, out, 1, 0, accessor );
135135
* // out => <Float64Array>[ 1.0, ~2.08, -3.0, ~4.327, -5.0 ]
@@ -156,8 +156,8 @@ interface Routine {
156156
* return v;
157157
* }
158158
*
159-
* var x = Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
160-
* var out = Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
159+
* var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
160+
* var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
161161
*
162162
* dcbrtBy( x.length, x, 1, out, 1, accessor );
163163
* // out => <Float64Array>[ 1.0, ~2.08, -3.0, ~4.327, -5.0 ]
@@ -169,8 +169,8 @@ interface Routine {
169169
* return v;
170170
* }
171171
*
172-
* var x = Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
173-
* var out = Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
172+
* var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
173+
* var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
174174
*
175175
* dcbrtBy.ndarray( x.length, x, 1, 0, out, 1, 0, accessor );
176176
* // out => <Float64Array>[ 1.0, ~2.08, -3.0, ~4.327, -5.0 ]

lib/node_modules/@stdlib/ndarray/slice/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* limitations under the License.
1717
*/
1818

19-
/* eslint-disable max-lines */
19+
/* eslint-disable max-lines, jsdoc/check-param-names */
2020

2121
// TypeScript Version: 4.1
2222

0 commit comments

Comments
 (0)