Skip to content

Commit ce21215

Browse files
committed
docs: update description
--- 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 07f68f0 commit ce21215

File tree

1 file changed

+5
-1
lines changed
  • lib/node_modules/@stdlib/ndarray/shift/docs/types

1 file changed

+5
-1
lines changed

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,11 @@ import { ndarray } from '@stdlib/types/ndarray';
2727
*/
2828
interface Options {
2929
/**
30-
* Dimension along which to perform the operation (Default: 0).
30+
* Dimension along which to perform the operation. Default: `-1`.
31+
*
32+
* ## Notes
33+
*
34+
* - 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`.
3135
*/
3236
dim?: number;
3337
}

0 commit comments

Comments
 (0)