Skip to content

Commit 694e0d9

Browse files
committed
docs: fix comment
--- 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: passed - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 69b1397 commit 694e0d9

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/gfind-index/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ var idx = gfindIndex( [ x ], isEven );
5555
// returns 2
5656
```
5757

58-
If the function is unable to find a search element, the function returns `-1`.
58+
If no element passes a test implemented by a predicate function, the function returns `-1`.
5959

6060
```javascript
6161
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
@@ -116,7 +116,6 @@ var count = ctx.count;
116116
## Notes
117117

118118
- If provided an empty one-dimensional ndarray, the function returns `-1`.
119-
- A provided callback function should return a boolean value.
120119

121120
</section>
122121

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
Returns the index of the first element in a one-dimensional ndarray which
44
passes a test implemented by a predicate function.
55

6-
If provided an empty ndarray, the function returns `-1`.
6+
If provided an empty ndarray or no element passes a test implemented by a
7+
predicate function, the function returns `-1`.
78

89
The callback function is provided three arguments:
910

1011
- value: current array element.
1112
- index: current array index.
1213
- array: the input ndarray.
1314

14-
The callback function should return a boolean value.
15-
1615
Parameters
1716
----------
1817
arrays: ArrayLikeObject<ndarray>

0 commit comments

Comments
 (0)