From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Mon, 22 Jul 2024 15:52:14 +0000 (-0600)
Subject: Add to the documentation.
X-Git-Tag: v9.6.0-rc1~22^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F17353%2Fhead;p=dealii.git

Add to the documentation.
---

diff --git a/include/deal.II/base/task_result.h b/include/deal.II/base/task_result.h
index a0501eb7ab..d06285bc3f 100644
--- a/include/deal.II/base/task_result.h
+++ b/include/deal.II/base/task_result.h
@@ -311,6 +311,12 @@ namespace Threads
      * assignment operator, this function considers it an
      * error (and throws an exception) if there is still a
      * currently running task associated with the object.
+     * Because you cannot know when a task associated with an
+     * object finishes, the practical realization of there not being
+     * a currently still running task is that you can only call this
+     * function on an object that has an associated task *after* you
+     * have either called join() or asked for the return value by
+     * having called value() (which internally calls join()).
      */
     void
     clear();