Skip to content

Commit 08a671a

Browse files
committed
docs: add note
--- 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent e49d1a0 commit 08a671a

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

lib/node_modules/@stdlib/ndarray/pop/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ arr = ndarray2array( y[ 1 ] );
6868

6969
The function accepts the following arguments:
7070

71-
- **x**: input ndarray.
71+
- **x**: input ndarray. Must have one or more dimensions.
7272
- **options**: function options. (_optional_)
7373

7474
The function supports the following `options`:

lib/node_modules/@stdlib/ndarray/pop/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Parameters
77
----------
88
x: ndarray
9-
Input ndarray.
9+
Input ndarray. Must have one or more dimensions.
1010

1111
options: Object (optional)
1212
Options.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ interface Options {
3939
/**
4040
* Returns an array containing a read-only truncated view of an input ndarray and a read-only view of the last element(s) along a specified dimension.
4141
*
42+
* ## Notes
43+
*
44+
* - The input array must have one or more dimensions.
45+
*
4246
* @param x - input array
4347
* @param options - function options
4448
* @param options.dim - dimension along which to perform the operation

0 commit comments

Comments
 (0)