Skip to content

Commit 577143b

Browse files
committed
update docstring
1 parent dbcdb86 commit 577143b

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

src/odrpack/odr_scipy.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ def odr_fit(f: Callable[[NDArray[np.float64], NDArray[np.float64]], NDArray[np.f
9999
are set to negative and positive infinity, respectively, for all elements
100100
of `beta`.
101101
task : Literal['explicit-ODR', 'implicit-ODR', 'OLS']
102-
Specifies the regression task to be performed. 'explicit-ODR' solves an
103-
orthogonal distance regression problem with an explicit model.
104-
'implicit-ODR' handles models defined implicitly. 'OLS' performs ordinary
105-
least squares fitting.
102+
Specifies the regression task to be performed. `'explicit-ODR'` solves
103+
an orthogonal distance regression problem with an explicit model.
104+
`'implicit-ODR'` handles models defined implicitly. `'OLS'` performs
105+
ordinary least squares fitting.
106106
fix_beta : NDArray[np.bool] | None
107107
Array with the same shape as `beta0`, specifying which elements of `beta`
108108
are to be held fixed. `True` means the parameter is fixed; `False` means
@@ -131,14 +131,14 @@ def odr_fit(f: Callable[[NDArray[np.float64], NDArray[np.float64]], NDArray[np.f
131131
the errors in the explanatory variable. By default, `delta0` is set to
132132
zero for all elements of `xdata`.
133133
diff_scheme : Literal['forward', 'central']
134-
Finite difference scheme used to approximate the Jacobian when the user
135-
does not provide `jac_beta` and `jac_x`. The default method is forward
136-
differences. Central differences are generally more accurate but require
137-
one additional `f` evaluation per partial derivative.
134+
Finite difference scheme used to approximate the Jacobian matrices when
135+
the user does not provide `jac_beta` and `jac_x`. The default method is
136+
forward differences. Central differences are generally more accurate but
137+
require one additional `f` evaluation per partial derivative.
138138
report : Literal['none', 'short', 'long', 'iteration']
139-
Specifies the level of computation reporting. 'none' disables all output.
140-
'short' prints a brief initial and final summary. 'long' provides a
141-
detailed initial and final summary. 'iteration' outputs information at
139+
Specifies the level of computation reporting. `'none'` disables all output.
140+
`'short'` prints a brief initial and final summary. `'long'` provides a
141+
detailed initial and final summary. `'iteration'` outputs information at
142142
each iteration step in addition to the detailed summaries. This is
143143
useful for debugging or monitoring progress.
144144
maxit : int | None

0 commit comments

Comments
 (0)