From 949a06bf360b827bb50eddef68461c5657943f91 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Thu, 18 May 2023 17:07:22 -0400 Subject: [PATCH] Improve description --- docs/source/API/core/execution_spaces.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/API/core/execution_spaces.rst b/docs/source/API/core/execution_spaces.rst index 0abd524dd..3f09402c9 100644 --- a/docs/source/API/core/execution_spaces.rst +++ b/docs/source/API/core/execution_spaces.rst @@ -313,7 +313,7 @@ Functions * ``const char* name() const;``: *Returns* the label of the execution space instance. -* ``bool is_running() const;``: *Returns* whether the execution space has completed all kernels submitted to it or if any of the kernels submitted are still running. +* ``bool is_running() const;``: *Returns* ``true`` if the execution space is currently executing a kernel, otherwise returns ``false``. Therefore, if the function returns ``false``, all kernels submitted by the current thread have been completed. * ``bool in_parallel() const;``: *Returns* a value convertible to ``bool`` indicating whether the caller is executing as part of a Kokkos parallel pattern. *Note:* as currently implemented, there is no guarantee that ``true`` means the caller is necessarily executing as part of a pattern on the particular instance |ExecutionSpaceConcept|_; just *some* instance of |ExecutionSpaceConcept|_. This may be strengthened in the future.