From 7ed069442ccb1ededbf6666d91d9b6390458f594 Mon Sep 17 00:00:00 2001 From: Max Shinn Date: Fri, 13 Sep 2024 08:16:56 +0100 Subject: [PATCH] Function doc clarification --- pyddm/sample.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pyddm/sample.py b/pyddm/sample.py index d10f790..8baa88a 100644 --- 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)