Skip to content

Commit 33d711b

Browse files
committed
docs: add missing forward slashes to return annotations
--- 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 266be21 commit 33d711b

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

lib/node_modules/@stdlib/blas/ddot/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import { float64ndarray } from '@stdlib/types/ndarray';
5252
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
5353
*
5454
* var z = ddot( x, y );
55-
* returns <ndarray>
55+
* // returns <ndarray>
5656
*
5757
* var v = z.get();
5858
* // returns -5.0

lib/node_modules/@stdlib/blas/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ interface Namespace {
6868
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
6969
*
7070
* var z = ns.ddot( x, y );
71-
* returns <ndarray>
71+
* // returns <ndarray>
7272
*
7373
* var v = z.get();
7474
* // returns -5.0
@@ -191,7 +191,7 @@ interface Namespace {
191191
* var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
192192
*
193193
* var z = ns.sdot( x, y );
194-
* returns <ndarray>
194+
* // returns <ndarray>
195195
*
196196
* var v = z.get();
197197
* // returns -5.0

lib/node_modules/@stdlib/blas/sdot/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import { float32ndarray } from '@stdlib/types/ndarray';
5252
* var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
5353
*
5454
* var z = sdot( x, y );
55-
* returns <ndarray>
55+
* // returns <ndarray>
5656
*
5757
* var v = z.get();
5858
* // returns -5.0

lib/node_modules/@stdlib/complex/base/parse/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import { ComplexLike } from '@stdlib/types/complex';
3434
* var str = '4 + 6i';
3535
*
3636
* var z = parse( str );
37-
* returns { re : 4, im : 6 }
37+
* // returns { re : 4, im : 6 }
3838
*/
3939
declare function parse( str: string ): ComplexLike | null;
4040

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ type Iterator = Iter | IterableIterator;
3939
* var it = iterCuAny( arr );
4040
*
4141
* var v = it.next().value;
42-
* returns false
42+
* // returns false
4343
*
4444
* v = it.next().value;
45-
* returns false
45+
* // returns false
4646
*
4747
* v = it.next().value;
48-
* returns false
48+
* // returns false
4949
*
5050
* v = it.next().value;
51-
* returns true
51+
* // returns true
5252
*
5353
* v = it.next().value;
54-
* returns true
54+
* // returns true
5555
*
5656
* var bool = it.next().done;
57-
* returns true
57+
* // returns true
5858
*/
5959
declare function iterCuAny( iterator: Iterator ): Iterator;
6060

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ type Iterator = Iter | IterableIterator;
3939
* var it = iterCuEvery( arr );
4040
*
4141
* var v = it.next().value;
42-
* returns true
42+
* // returns true
4343
*
4444
* v = it.next().value;
45-
* returns true
45+
* // returns true
4646
*
4747
* v = it.next().value;
48-
* returns true
48+
* // returns true
4949
*
5050
* v = it.next().value;
51-
* returns false
51+
* // returns false
5252
*
5353
* v = it.next().value;
54-
* returns false
54+
* // returns false
5555
*
5656
* var bool = it.next().done;
57-
* returns true
57+
* // returns true
5858
*/
5959
declare function iterCuEvery( iterator: Iterator ): Iterator;
6060

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ type Iterator = Iter | IterableIterator;
3939
* var it = iterCuNone( arr );
4040
*
4141
* var v = it.next().value;
42-
* returns true
42+
* // returns true
4343
*
4444
* v = it.next().value;
45-
* returns true
45+
* // returns true
4646
*
4747
* v = it.next().value;
48-
* returns true
48+
* // returns true
4949
*
5050
* v = it.next().value;
51-
* returns false
51+
* // returns false
5252
*
5353
* v = it.next().value;
54-
* returns false
54+
* // returns false
5555
*
5656
* var bool = it.next().done;
57-
* returns true
57+
* // returns true
5858
*/
5959
declare function iterCuNone( iterator: Iterator ): Iterator;
6060

0 commit comments

Comments
 (0)