Skip to content

Commit bd812bd

Browse files
committed
devdocs: add missing Bool argument for bounds checking [ci skip]
1 parent 511fc89 commit bd812bd

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/devdocs/boundscheck.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ The overall hierarchy is:
6767

6868
| ``checkbounds(A, I...)`` which calls
6969
| ``checkbounds(Bool, A, I...)`` which calls either of:
70-
| ``checkbounds_logical(A, I)`` when ``I`` is a single logical array
71-
| ``checkbounds_indices(indices(A), I)`` otherwise
70+
| ``checkbounds_logical(Bool, A, I)`` when ``I`` is a single logical array
71+
| ``checkbounds_indices(Bool, indices(A), I)`` otherwise
7272
|
7373
7474
Here ``A`` is the array, and ``I`` contains the "requested" indices.
@@ -85,8 +85,8 @@ dimensions handled by calling another important function,
8585
``checkindex``: typically,
8686
::
8787

88-
checkbounds_indices((IA1, IA...), (I1, I...)) = checkindex(Bool, IA1, I1) &
89-
checkbounds_indices(IA, I)
88+
checkbounds_indices(Bool, (IA1, IA...), (I1, I...)) = checkindex(Bool, IA1, I1) &
89+
checkbounds_indices(Bool, IA, I)
9090

9191
so ``checkindex`` checks a single dimension. All of these functions,
9292
including the unexported ``checkbounds_indices`` and

0 commit comments

Comments
 (0)