Skip to content

Commit 1634973

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: 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 2d758d2 commit 1634973

File tree

1 file changed

+1
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/base/normalize-indices

1 file changed

+1
-0
lines changed

lib/node_modules/@stdlib/ndarray/base/normalize-indices/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ var idx = normalizeIndices( [ 15, -15 ], 10 );
6767
## Notes
6868

6969
- The function mutates the input array, even when provided an out-of-bounds index. If mutation is undesired, copy the input array before calling this function.
70+
- During normalization, a negative index is converted to a nonnegative index according to `max + idx + 1`. If, after normalization, the resolved index is still negative, the value is considered out-of-bounds.
7071

7172
</section>
7273

0 commit comments

Comments
 (0)