Skip to content

Commit 346d1b2

Browse files
committed
make bounds to restraints docstring better
1 parent 91a2ef4 commit 346d1b2

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

src/diffpy/srfit/fitbase/fitrecipe.py

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1429,13 +1429,18 @@ def convert_bounds_to_restraints(self, sig=1, scaled=False):
14291429
14301430
The bounds become limits on the restraint.
14311431
1432-
Attributes
1432+
Parameters
14331433
----------
1434-
sig
1435-
The uncertainty on the bounds (scalar or iterable,
1436-
default 1).
1437-
scaled
1438-
Scale the restraints, see restrain.
1434+
sig : float or iterable of float, optional
1435+
The number of standard deviations associated with each bound.
1436+
Smaller values produce stronger restraints. If a scalar is given,
1437+
the same value is applied to all parameters. If an iterable is
1438+
provided, it must match the number of parameters. Default is 1.
1439+
1440+
scaled : bool, optional
1441+
If True, scale each restraint by the magnitude of the corresponding
1442+
parameter, consistent with the behavior of :meth:`restrain`.
1443+
Default is False.
14391444
"""
14401445
pars = self._parameters.values()
14411446
if not hasattr(sig, "__iter__"):

0 commit comments

Comments
 (0)