[Doc] Update docstring for Kinetics::checkDuplicates

Cantera · Jan 27, 2017 · 2678b57 · 2678b57
1 parent c982f50
commit 2678b57
Showing 1 changed file with 9 additions and 6 deletions.
diff --git a/include/cantera/kinetics/Kinetics.h b/include/cantera/kinetics/Kinetics.h
@@ -846,12 +846,15 @@ class Kinetics
         return true;
     }
 
-    //! Check for duplicate reactions.
-    /**
-     * If `throw_err` is true, then an exception will be thrown if any unmarked
-     * duplicate reactions are found. Otherwise, the indices of the first pair
-     * of duplicate reactions found will be returned. If no duplicate reactions
-     * are found, returns `(npos, npos)`.
+    //! Check for unmarked duplicate reactions and unmatched marked duplicates
+    /**
+     * If `throw_err` is true, then an exception will be thrown if either any
+     * unmarked duplicate reactions are found, or if any marked duplicate
+     * reactions do not have a matching duplicate reaction. If `throw_err` is
+     * false, the indices of the first pair of duplicate reactions found will be
+     * returned, or the index of the unmatched duplicate will be returned as
+     * both elements of the pair. If no unmarked duplicates or unmatched marked
+     * duplicate reactions are found, returns `(npos, npos)`.
      */
     virtual std::pair<size_t, size_t> checkDuplicates(bool throw_err=true) const;