Skip to content

Commit c13c153

Browse files
committed
docs: document exceptions
--- 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: passed - 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 0e81d53 commit c13c153

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

lib/node_modules/@stdlib/array/to-fancy/lib/get_element.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ var resolveIndex = require( './resolve_index.js' );
3434
* @param {Object} ctx - context object
3535
* @param {Function} ctx.getter - accessor for retrieving array elements
3636
* @param {boolean} ctx.strict - boolean indicating whether to enforce strict bounds checking
37+
* @throws {RangeError} index exceeds array bounds
3738
* @returns {*} result
3839
*/
3940
function getElement( target, property, ctx ) {

lib/node_modules/@stdlib/array/to-fancy/lib/set_element.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ var resolveIndex = require( './resolve_index.js' );
4040
* @param {(Function|null)} ctx.preSetElement - function for normalizing new values (if necessary)
4141
* @throws {TypeError} assigned value cannot be safely cast to the target array data type
4242
* @throws {TypeError} target array must have a supported data type
43+
* @throws {RangeError} index exceeds array bounds
4344
* @returns {boolean} boolean indicating whether assignment succeeded
4445
*/
4546
function setElement( target, property, value, ctx ) {

0 commit comments

Comments
 (0)