#672: docs: clarify tree descendant node inclusion

DARMA-tasking · Jun 22, 2020 · ae27569 · ae27569
1 parent f4cdf5e
commit ae27569
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/vt/collective/tree/tree.h b/src/vt/collective/tree/tree.h
@@ -169,7 +169,9 @@ struct Tree {
 
   /**
    * \internal \brief Get total number of descendants for a particular node in
-   * the tree
+   * the tree.
+   *
+   * The returned count does not include the node passed---only its descendants.
    *
    * \param[in] child the node
    *