From b40146401090417c2c3cf88f1dd43395c94c0926 Mon Sep 17 00:00:00 2001 From: Tom Donoghue Date: Thu, 9 Mar 2023 06:49:02 -0500 Subject: [PATCH] add better description to calc_error options --- fooof/objs/fit.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/fooof/objs/fit.py b/fooof/objs/fit.py index 827afa9e9..438926081 100644 --- a/fooof/objs/fit.py +++ b/fooof/objs/fit.py @@ -1108,7 +1108,10 @@ def _calc_error(self, metric=None): Parameters ---------- metric : {'MAE', 'MSE', 'RMSE'}, optional - Which error measure to calculate. + Which error measure to calculate: + * 'MAE' : mean absolute error + * 'MSE' : mean squared error + * 'RMSE' : root mean squared error Raises ------