Skip to content

Commit

Permalink
Improve description
Browse files Browse the repository at this point in the history
  • Loading branch information
masterleinad committed May 18, 2023
1 parent 4437abe commit 949a06b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/API/core/execution_spaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 949a06b

Please sign in to comment.