Function doc clarification

mwshinn · Sep 13, 2024 · 7ed0694 · 7ed0694
1 parent 05c8e5f
commit 7ed0694
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/pyddm/sample.py b/pyddm/sample.py
@@ -659,7 +659,12 @@ def prob_error_forced(self):
     @requires("len(self.choice_upper) > 0")
     @returns(Positive0)
     def mean_decision_time(self):
-        """The mean decision time in the correct trials."""
+        """The mean decision time in the correct trials.
+
+        This only works when choice_names is "correct" and "error".  The
+        function mean_rt() includes all trials (not just correct trials) and
+        thus works for all models.
+        """
         if self.choice_names != ("correct", "error"):
             raise NotImplementedError("Choice names need to be set to \"correct\" and \"error\" to use this function.  See the mean_rt method.")
         return np.mean(self.choice_upper)