Skip to content

Commit

Permalink
DOC: fix typos/mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
schtandard committed Nov 1, 2022
1 parent 3219116 commit b58c139
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/constraints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ highly desirable to place mathematical constraints on parameter values.
For example, one might want to require that two Gaussian peaks have the
same width, or have amplitudes that are constrained to add to some value.
Of course, one could rewrite the objective or model function to place such
requirements, but this is somewhat error prone, and limits the flexibility
requirements, but this is somewhat error-prone, and limits the flexibility
so that exploring constraints becomes laborious.

To simplify the setting of constraints, Parameters can be assigned a
Expand Down
4 changes: 2 additions & 2 deletions doc/fitting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Choosing Different Fitting Methods
By default, the `Levenberg-Marquardt
<https://en.wikipedia.org/wiki/Levenberg-Marquardt_algorithm>`_ algorithm is
used for fitting. While often criticized, including the fact it finds a
*local* minima, this approach has some distinct advantages. These include
*local* minimum, this approach has some distinct advantages. These include
being fast, and well-behaved for most curve-fitting needs, and making it
easy to estimate uncertainties for and correlations between pairs of fit
variables, as discussed in :ref:`fit-results-label`.
Expand Down Expand Up @@ -476,7 +476,7 @@ be used to abort a fit.
:type resid: numpy.ndarray
:param args: Positional arguments. Must match ``args`` argument to :func:`minimize`
:param kws: Keyword arguments. Must match ``kws`` argument to :func:`minimize`
:return: Residual array (generally ``data-model``) to be minimized in the least-squares sense.
:return: Iteration abort flag.
:rtype: None for normal behavior, any value like ``True`` to abort the fit.


Expand Down
2 changes: 1 addition & 1 deletion doc/model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ Parameters if the supplied default value was a valid number (but not
.. jupyter-execute::

def decay2(t, tau, N=10, check_positive=False):
if check_small:
if check_positive:
arg = abs(t)/max(1.e-9, abs(tau))
else:
arg = t/tau
Expand Down

0 comments on commit b58c139

Please sign in to comment.