Add comment on when DeviceReset is called.

Co-authored-by: @yhmtsai <yu-hsiang.tsai@kit.edu>
ginkgo-project · Jun 9, 2020 · 14205b6 · 14205b6
1 parent 4586679
commit 14205b6
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/include/ginkgo/core/base/executor.hpp b/include/ginkgo/core/base/executor.hpp
@@ -785,7 +785,10 @@ class ExecutorBase : public Executor {
 
 /**
  * Controls whether the DeviceReset function should be called thanks to a
- * boolean.
+ * boolean. Note that in any case, `DeviceReset` is called only after destroying
+ * the last Ginkgo executor. Therefore, it is sufficient to set this flag to the
+ * last living executor in Ginkgo. Setting this flag to an executor which is not
+ * destroyed last has no effect.
  */
 class EnableDeviceReset {
 public: