Skip to content

Commit

Permalink
Update devdocs for bounds checking following #18401
Browse files Browse the repository at this point in the history
I had forgotten that this behavior was documented in the developer section of the manual when authoring #18401.

[ci skip]
  • Loading branch information
mbauman authored Sep 16, 2016
1 parent 3a31155 commit b8406ff
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/devdocs/boundscheck.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ The bounds checking call hierarchy
The overall hierarchy is:

| ``checkbounds(A, I...)`` which calls
| ``checkbounds(Bool, A, I...)`` which calls either of:
| ``checkbounds_logical(Bool, A, I)`` when ``I`` is a single logical array
| ``checkbounds_indices(Bool, indices(A), I)`` otherwise
| ``checkbounds(Bool, A, I...)`` which calls
| ``checkbounds_indices(Bool, indices(A), I)`` which recursively calls
| ``checkindex`` for each dimension
|
Here ``A`` is the array, and ``I`` contains the "requested" indices.
Expand All @@ -89,8 +89,8 @@ dimensions handled by calling another important function,
checkbounds_indices(Bool, IA, I)

so ``checkindex`` checks a single dimension. All of these functions,
including the unexported ``checkbounds_indices`` and
``checkbounds_logical``, have docstrings accessible with ``?`` .
including the unexported ``checkbounds_indices`` have docstrings
accessible with ``?`` .

If you have to customize bounds checking for a specific array type,
you should specialize ``checkbounds(Bool, A, I...)``. However, in most
Expand Down

0 comments on commit b8406ff

Please sign in to comment.