Merge pull request #253 from fooof-tools/docs

[MNT] - Add better description to calc_error options
fooof-tools · Mar 9, 2023 · 8d8cb96 · 8d8cb96
2 parents baed4d5 + b401464
commit 8d8cb96
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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
         ------