Skip to content

Commit 2d758d2

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 705dd30 commit 2d758d2

File tree

1 file changed

+4
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/base/normalize-index

1 file changed

+4
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ idx = normalizeIndex( -15, 10 );
7070

7171
<section class="notes">
7272

73+
## Notes
74+
75+
- 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.
76+
7377
</section>
7478

7579
<!-- /.notes -->

0 commit comments

Comments
 (0)