Skip to content

Commit e49d1a0

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 4583470 commit e49d1a0

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

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

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

7272
The function accepts the following arguments:
7373

74-
- **x**: input ndarray.
74+
- **x**: input ndarray. Must have one or more dimensions.
7575
- **dim**: dimension along which to perform the operation. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
7676
- **writable**: boolean indicating whether a returned ndarray should be writable.
7777

lib/node_modules/@stdlib/ndarray/base/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
dim: integer
1212
Dimension along which to perform the operation. If provided an integer

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ import { ndarray } from '@stdlib/types/ndarray';
2525
/**
2626
* Returns an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.
2727
*
28+
* ## Notes
29+
*
30+
* - The input array must have one or more dimensions.
31+
*
2832
* @param x - input array
2933
* @param dim - dimension along which to perform the operation
3034
* @param writable - boolean indicating whether returned arrays should be writable

0 commit comments

Comments
 (0)