Skip to content

Commit 7ea9935

Browse files
authored
fix the docstrings (#77)
* reflow and "Just like" → "Like" * fix the note blocks for interp
1 parent de2257b commit 7ea9935

File tree

1 file changed

+23
-27
lines changed

1 file changed

+23
-27
lines changed

pint_xarray/accessors.py

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -422,12 +422,12 @@ def reindex(
422422
):
423423
"""unit-aware version of reindex
424424
425-
Just like :py:meth:`xarray.DataArray.reindex`, except the object's indexes are converted
426-
to the units of the indexers first.
425+
Like :py:meth:`xarray.DataArray.reindex`, except the object's indexes are
426+
converted to the units of the indexers first.
427427
428428
.. note::
429-
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed through to
430-
``DataArray.reindex`` unmodified.
429+
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed
430+
through to ``DataArray.reindex`` unmodified.
431431
432432
See Also
433433
--------
@@ -490,12 +490,12 @@ def reindex_like(
490490
):
491491
"""unit-aware version of reindex_like
492492
493-
Just like :py:meth:`xarray.DataArray.reindex_like`, except the object's indexes are converted
494-
to the units of the indexers first.
493+
Like :py:meth:`xarray.DataArray.reindex_like`, except the object's indexes
494+
are converted to the units of the indexers first.
495495
496496
.. note::
497-
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed through to
498-
``DataArray.reindex_like`` unmodified.
497+
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed
498+
through to ``DataArray.reindex_like`` unmodified.
499499
500500
See Also
501501
--------
@@ -550,12 +550,11 @@ def interp(
550550
):
551551
"""unit-aware version of interp
552552
553-
Just like :py:meth:`xarray.DataArray.interp`, except the object's indexes are converted
554-
to the units of the indexers first.
553+
Like :py:meth:`xarray.DataArray.interp`, except the object's indexes are
554+
converted to the units of the indexers first.
555555
556556
.. note::
557-
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed through to
558-
``DataArray.interp`` unmodified.
557+
``kwargs`` is passed unmodified to ``DataArray.interp``
559558
560559
See Also
561560
--------
@@ -614,12 +613,11 @@ def interp(
614613
def interp_like(self, other, method="linear", assume_sorted=False, kwargs=None):
615614
"""unit-aware version of interp_like
616615
617-
Just like :py:meth:`xarray.DataArray.interp_like`, except the object's indexes are converted
616+
Like :py:meth:`xarray.DataArray.interp_like`, except the object's indexes are converted
618617
to the units of the indexers first.
619618
620619
.. note::
621-
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed through to
622-
``DataArray.interp_like`` unmodified.
620+
``kwargs`` is passed unmodified to ``DataArray.interp``
623621
624622
See Also
625623
--------
@@ -668,7 +666,7 @@ def sel(
668666
):
669667
"""unit-aware version of sel
670668
671-
Just like :py:meth:`xarray.DataArray.sel`, except the object's indexes are converted
669+
Like :py:meth:`xarray.DataArray.sel`, except the object's indexes are converted
672670
to the units of the indexers first.
673671
674672
.. note::
@@ -1014,7 +1012,7 @@ def reindex(
10141012
):
10151013
"""unit-aware version of reindex
10161014
1017-
Just like :py:meth:`xarray.Dataset.reindex`, except the object's indexes are converted
1015+
Like :py:meth:`xarray.Dataset.reindex`, except the object's indexes are converted
10181016
to the units of the indexers first.
10191017
10201018
.. note::
@@ -1082,7 +1080,7 @@ def reindex_like(
10821080
):
10831081
"""unit-aware version of reindex_like
10841082
1085-
Just like :py:meth:`xarray.Dataset.reindex_like`, except the object's indexes are converted
1083+
Like :py:meth:`xarray.Dataset.reindex_like`, except the object's indexes are converted
10861084
to the units of the indexers first.
10871085
10881086
.. note::
@@ -1142,12 +1140,11 @@ def interp(
11421140
):
11431141
"""unit-aware version of interp
11441142
1145-
Just like :py:meth:`xarray.Dataset.interp`, except the object's indexes are converted
1143+
Like :py:meth:`xarray.Dataset.interp`, except the object's indexes are converted
11461144
to the units of the indexers first.
11471145
11481146
.. note::
1149-
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed through to
1150-
``Dataset.interp`` unmodified.
1147+
``kwargs`` is passed unmodified to ``Dataset.interp``
11511148
11521149
See Also
11531150
--------
@@ -1206,12 +1203,11 @@ def interp(
12061203
def interp_like(self, other, method="linear", assume_sorted=False, kwargs=None):
12071204
"""unit-aware version of interp_like
12081205
1209-
Just like :py:meth:`xarray.Dataset.interp_like`, except the object's indexes are converted
1210-
to the units of the indexers first.
1206+
Like :py:meth:`xarray.Dataset.interp_like`, except the object's indexes are
1207+
converted to the units of the indexers first.
12111208
12121209
.. note::
1213-
``tolerance`` and ``fill_value`` are not supported, yet. They will be passed through to
1214-
``Dataset.interp_like`` unmodified.
1210+
``kwargs`` is passed unmodified to ``Dataset.interp``
12151211
12161212
See Also
12171213
--------
@@ -1260,8 +1256,8 @@ def sel(
12601256
):
12611257
"""unit-aware version of sel
12621258
1263-
Just like :py:meth:`xarray.Dataset.sel`, except the object's indexes are converted to the units
1264-
of the indexers first.
1259+
Like :py:meth:`xarray.Dataset.sel`, except the object's indexes are converted to
1260+
the units of the indexers first.
12651261
12661262
.. note::
12671263
``tolerance`` is not supported, yet. It will be passed through to

0 commit comments

Comments
 (0)