DOC: clarify "weights" in docstring of Model.fit()

lmfit · May 15, 2022 · b930dde · b930dde
1 parent 22ebbd9
commit b930dde
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/lmfit/model.py b/lmfit/model.py
@@ -901,8 +901,9 @@ def fit(self, data, params=None, weights=None, method='leastsq',
         params : Parameters, optional
             Parameters to use in fit (default is None).
         weights : array_like, optional
-            Weights to use for the calculation of the fit residual
-            (default is None). Must have the same size as `data`.
+            Weights to use for the calculation of the fit residual [i.e.,
+            `weights*(data-fit)`]. Default is None; must have the same size as
+            `data`.
         method : str, optional
             Name of fitting method to use (default is `'leastsq'`).
         iter_cb : callable, optional