Skip to content

Commit 5d9d263

Browse files
committed
silence more sphinx warnings
1 parent c9b53bd commit 5d9d263

File tree

6 files changed

+14
-13
lines changed

6 files changed

+14
-13
lines changed

doc/whats-new.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Documentation
229229
(pull:`3331`, pull:`3331`). By `Justus Magin <https://github.com/keewis>`_.
230230
- Add examples for :py:meth:`align`, :py:meth:`merge`, :py:meth:`combine_by_coords`,
231231
:py:meth:`full_like`, :py:meth:`zeros_like`, :py:meth:`ones_like`, :py:meth:`Dataset.pipe`,
232-
:py:meth:`Dataset.assign`, :py:meth:`Dataset.reindex`, :py:meth:`Dataset.fillna` (pull:`3328`).
232+
:py:meth:`Dataset.assign`, :py:meth:`Dataset.reindex`, :py:meth:`Dataset.fillna` (:pull:`3328`).
233233
By `Anderson Banihirwe <https://github.com/andersy005>`_.
234234
- Fixed documentation to clean up an unwanted file created in ``ipython`` example
235235
(:pull:`3353`). By `Gregory Gundersen <https://github.com/gwgundersen/>`_.

xarray/backends/api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@ def open_mfdataset(
735735
Parameters
736736
----------
737737
paths : str or sequence
738-
Either a string glob in the form "path/to/my/files/*.nc" or an explicit list of
738+
Either a string glob in the form ``"path/to/my/files/*.nc"`` or an explicit list of
739739
files to open. Paths can be given as strings or as pathlib Paths. If
740740
concatenation along more than one dimension is desired, then ``paths`` must be a
741741
nested list-of-lists (see ``manual_combine`` for details). (A string glob will

xarray/core/dataarray.py

+7-6
Original file line numberDiff line numberDiff line change
@@ -1314,7 +1314,7 @@ def interp(
13141314
values.
13151315
kwargs: dictionary
13161316
Additional keyword passed to scipy's interpolator.
1317-
**coords_kwarg : {dim: coordinate, ...}, optional
1317+
``**coords_kwarg`` : {dim: coordinate, ...}, optional
13181318
The keyword arguments form of ``coords``.
13191319
One of coords or coords_kwargs must be provided.
13201320
@@ -2028,9 +2028,10 @@ def interpolate_na(
20282028
----------
20292029
dim : str
20302030
Specifies the dimension along which to interpolate.
2031-
method : {'linear', 'nearest', 'zero', 'slinear', 'quadratic', 'cubic',
2032-
'polynomial', 'barycentric', 'krog', 'pchip',
2033-
'spline', 'akima'}, optional
2031+
method : {'linear', 'nearest', 'zero', 'slinear', 'quadratic',
2032+
'cubic', 'polynomial', 'barycentric', 'krog', 'pchip',
2033+
'spline', 'akima'}, optional
2034+
20342035
String indicating which method to use for interpolation:
20352036
20362037
- 'linear': linear interpolation (Default). Additional keyword
@@ -3041,8 +3042,8 @@ def integrate(
30413042
Coordinate(s) used for the integration.
30423043
datetime_unit: str, optional
30433044
Can be used to specify the unit if datetime coordinate is used.
3044-
One of {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns',
3045-
'ps', 'fs', 'as'}
3045+
One of {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', 'ps',
3046+
'fs', 'as'}
30463047
30473048
Returns
30483049
-------

xarray/core/dataset.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1499,7 +1499,7 @@ def to_netcdf(
14991499
Nested dictionary with variable names as keys and dictionaries of
15001500
variable specific encodings as values, e.g.,
15011501
``{'my_variable': {'dtype': 'int16', 'scale_factor': 0.1,
1502-
'zlib': True}, ...}``
1502+
'zlib': True}, ...}``
15031503
15041504
The `h5netcdf` engine supports both the NetCDF4-style compression
15051505
encoding parameters ``{'zlib': True, 'complevel': 9}`` and the h5py
@@ -2117,7 +2117,7 @@ def thin(
21172117
A dict with keys matching dimensions and integer values `n`
21182118
or a single integer `n` applied over all dimensions.
21192119
One of indexers or indexers_kwargs must be provided.
2120-
**indexers_kwargs : {dim: n, ...}, optional
2120+
``**indexers_kwargs`` : {dim: n, ...}, optional
21212121
The keyword arguments form of ``indexers``.
21222122
One of indexers or indexers_kwargs must be provided.
21232123

xarray/core/groupby.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -687,9 +687,9 @@ def map(self, func, shortcut=False, args=(), **kwargs):
687687
If these conditions are satisfied `shortcut` provides significant
688688
speedup. This should be the case for many common groupby operations
689689
(e.g., applying numpy ufuncs).
690-
args : tuple, optional
690+
``*args`` : tuple, optional
691691
Positional arguments passed to `func`.
692-
**kwargs
692+
``**kwargs``
693693
Used to call `func(ar, **kwargs)` for each array `ar`.
694694
695695
Returns

xarray/plot/plot.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ def line(
269269
if None, use the default for the matplotlib function.
270270
add_legend : boolean, optional
271271
Add legend with y axis coordinates (2D inputs only).
272-
*args, **kwargs : optional
272+
``*args``, ``**kwargs`` : optional
273273
Additional arguments to matplotlib.pyplot.plot
274274
"""
275275
# Handle facetgrids first

0 commit comments

Comments
 (0)