Skip to content

Commit 643b8da

Browse files
committed
docs: fix repl docs
--- 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: passed - 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 ed598de commit 643b8da

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

lib/node_modules/@stdlib/blas/ext/base/gfind-index/docs/repl.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
Indexing is relative to the first index. To introduce an offset, use typed
1010
array views.
1111

12-
If `N <= 0`, the function returns `-1`.
12+
If `N <= 0` or no element passes a test implemented by a predicate function,
13+
the function returns `-1`.
1314

1415
The callback function is provided the following arguments:
1516

lib/node_modules/@stdlib/blas/ext/base/gfind-index/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ interface Routine {
104104
* @param strideX - stride length
105105
* @param clbk - callback function
106106
* @param thisArg - execution context
107-
* @returns `index`
107+
* @returns index
108108
*
109109
* @example
110110
* function isEven( v ) {
@@ -136,7 +136,7 @@ interface Routine {
136136
* @param offsetX - starting index
137137
* @param clbk - callback function
138138
* @param thisArg - execution context
139-
* @returns `index`
139+
* @returns index
140140
*
141141
* @example
142142
* function isEven( v ) {
@@ -168,7 +168,7 @@ interface Routine {
168168
* @param strideX - stride length
169169
* @param clbk - callback function
170170
* @param thisArg - execution context
171-
* @returns `index`
171+
* @returns index
172172
*
173173
* @example
174174
* function isEven( v ) {

0 commit comments

Comments
 (0)