#1967: modify phrasing in asserts and warnings

DARMA-tasking · Sep 19, 2022 · c537410 · c537410
1 parent 49ffa10
commit c537410
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/vt/termination/termination.cc b/src/vt/termination/termination.cc
@@ -1234,14 +1234,14 @@ std::size_t TerminationDetector::getNumTerminatedCollectiveEpochs() const {
 }
 
 void TerminationDetector::disableTD(EpochType in_epoch) {
-  vtAssert(not isDS(in_epoch), "Must not be a DS epoch");
+  vtAssert(not isDS(in_epoch), "Must be a wave based epoch");
   auto& state = in_epoch == any_epoch_sentinel ?
     any_epoch_state_ : findOrCreateState(in_epoch, false);
   state.incrementDependency();
 }
 
 void TerminationDetector::enableTD(EpochType in_epoch) {
-  vtAssert(not isDS(in_epoch), "Must not be a DS epoch");
+  vtAssert(not isDS(in_epoch), "Must be a wave based epoch");
   auto& state = in_epoch == any_epoch_sentinel ?
     any_epoch_state_ : findOrCreateState(in_epoch, false);
   state.decrementDependency();

diff --git a/src/vt/termination/termination.h b/src/vt/termination/termination.h
@@ -648,7 +648,7 @@ struct TerminationDetector :
    * \brief Disable termination detection on an epoch. Local counting is still
    * enabled, but any non-local progress is halted until it is enabled
    *
-   * \warning Does not work with DS epochs
+   * \warning Does not work with DS epochs. It must be a wave based epoch.
    *
    * \param[in] in_epoch the epoch
    */
@@ -657,7 +657,7 @@ struct TerminationDetector :
   /**
    * \brief Enable termination detection on an epoch.
    *
-   * \warning Does not work with DS epochs
+   * \warning Does not work with DS epochs. It must be a wave based epoch.
    *
    * \param[in] in_epoch the epoch
    */