Added a note on bounds precondition in RangePolicy and MDRangePolicy

kokkos · Jan 11, 2024 · 2bf5642 · 2bf5642
1 parent b5cd6a0
commit 2bf5642
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/source/API/core/policies/MDRangePolicy.rst b/docs/source/API/core/policies/MDRangePolicy.rst
@@ -86,6 +86,11 @@ Constructors
 
     * Provide a start and end index as well as the tiling dimensions. The length of the lists must match the rank of the policy.
 
+``Notes``:
+^^^^^^^^^^
+
+* Provided start index must not be greater than the matching end index for all ranks. Otherwise, ``Kokkos::abort()`` is called.
+
 Examples
 --------
 

diff --git a/docs/source/API/core/policies/RangePolicy.rst b/docs/source/API/core/policies/RangePolicy.rst
@@ -114,6 +114,11 @@ Optional ``InitArgs``:
 
 * ``ChunkSize`` : Provide a hint for optimal chunk-size to be used during scheduling. For the SYCL backend, the workgroup size used in a ``parallel_for`` kernel can be set via this variable.
 
+``Notes``:
+^^^^^^^^^^
+
+* Provided start index must not be greater than the end index. Otherwise, ``Kokkos::abort()`` is called.
+
 Examples
 --------