Skip to content

Commit cd19c6b

Browse files
committedMar 10, 2025·
docs: update disclaimer and fix broken intersphinx links
1 parent 6088fff commit cd19c6b

File tree

6 files changed

+23
-11
lines changed

6 files changed

+23
-11
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ xarray-lmfit is a Python package that bridges the power of [xarray](http://xarra
1313

1414
With xarray-lmfit, [lmfit models](https://lmfit.github.io/lmfit-py/model.html) can be fit to xarray Datasets and DataArrays, automatically propagating across multiple dimensions. The fit results are stored as xarray Datasets, retaining the original coordinates and dimensions of the input data.
1515

16-
Disclaimer: Please note that this package is not affiliated with either the xarray or lmfit projects. Any issues arising from its use should be reported to the [xarray-lmfit issue tracker](https://github.com/kmnhan/xarray-lmfit/issues) rather than to the xarray or lmfit projects.
16+
Disclaimer: Please note that this package is independent and not affiliated with the xarray or lmfit projects. If you encounter any issues, please report them on the [xarray-lmfit issue tracker](https://github.com/kmnhan/xarray-lmfit/issues).
1717

1818
## Installation
1919

‎docs/source/conf.py

+8-3
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,21 @@
7777
napoleon_use_rtype = True
7878
napoleon_preprocess_types = True
7979
napoleon_type_aliases = {
80-
"ndarray": "numpy.ndarray",
80+
"Hashable": ":obj:`Hashable <collections.abc.Hashable>`",
81+
"Mapping": ":obj:`Mapping <collections.abc.Mapping>`",
82+
"Sequence": ":obj:`Sequence <collections.abc.Sequence>`",
83+
"Iterable": ":obj:`Iterable <collections.abc.Iterable>`",
84+
"Callable": ":obj:`Callable <collections.abc.Callable>`",
85+
"ndarray": ":class:`numpy.ndarray`",
8186
"DataArray": ":class:`DataArray <xarray.DataArray>`",
8287
"Dataset": ":class:`Dataset <xarray.Dataset>`",
8388
"DataTree": ":class:`DataTree <xarray.DataTree>`",
8489
"np.float32": "float32",
8590
"numpy.float32": "float32",
8691
"np.float64": "float64",
8792
"numpy.float64": "float64",
88-
"array-like": "`array-like <numpy.typing.ArrayLike>`",
89-
"path-like": "`path-like <os.PathLike>`",
93+
"array-like": ":obj:`array-like <numpy.typing.ArrayLike>`",
94+
"path-like": ":obj:`path-like <os.PathLike>`",
9095
"lmfit.Parameters": ":class:`lmfit.Parameters <lmfit.parameter.Parameters>`",
9196
"lmfit.Model": ":class:`lmfit.Model <lmfit.model.Model>`",
9297
}

‎docs/source/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ The import name is `xarray_lmfit` (with an underscore `_`), not `xarray-lmfit`.
3333

3434
:::
3535

36-
If the installation was successful, you should see the version number of `xarray-lmfit` printed to the console.
36+
If the installation was successful, you should see the version number printed to the console.

‎docs/source/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ xarray-lmfit is a Python package that bridges the power of [xarray](http://xarra
2929

3030
With xarray-lmfit, [lmfit models](https://lmfit.github.io/lmfit-py/model.html) can be fit to xarray Datasets and DataArrays, automatically propagating across multiple dimensions. The fit results are stored as xarray Datasets, retaining the original coordinates and dimensions of the input data.
3131

32+
```{admonition} Disclaimer
33+
34+
Please note that this package is independent and not affiliated with the xarray or lmfit projects. If you encounter any issues, please report them on the [xarray-lmfit issue tracker](https://github.com/kmnhan/xarray-lmfit/issues).
35+
36+
```
37+
3238
```{toctree}
3339
:caption: Contents
3440
:maxdepth: 2

‎src/xarray_lmfit/modelfit.py

+6-5
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,19 @@ def __call__(
161161
params : lmfit.Parameters, dict-like, DataArray or Dataset, optional
162162
Optional input parameters to the fit.
163163
164-
- If a `lmfit.Parameters <lmfit.parameter.Parameters>` object, it will be
165-
used for all fits.
164+
- If a :class:`lmfit.Parameters <lmfit.parameter.Parameters>` object, it
165+
will be used for all fits.
166166
167167
- If a dict-like object, it must be structured like keyword arguments to
168168
:func:`lmfit.create_params <lmfit.parameter.create_params>`.
169169
170170
Additionally, each value of the dictionary may also be a DataArray, which
171171
will be broadcasted appropriately.
172172
173-
- If a DataArray, each entry must be a dict-like object, a `lmfit.Parameters
174-
<lmfit.parameter.Parameters>` object, or a JSON string created with
175-
:meth:`lmfit.Parameters.dumps <lmfit.parameter.Parameters.dumps>`.
173+
- If a DataArray, each entry must be a dict-like object, a
174+
:class:`lmfit.Parameters <lmfit.parameter.Parameters>` object, or a JSON
175+
string created with :meth:`lmfit.Parameters.dumps
176+
<lmfit.parameter.Parameters.dumps>`.
176177
177178
- If a Dataset, the name of the data variables in the Dataset must match the
178179
name of the data variables in the calling object, and each data variable

‎uv.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.