Skip to content

Commit

Permalink
MNT: Some docstring clean-ups
Browse files Browse the repository at this point in the history
Found by flake8-rst-docstrings or found while working on other fixes.
  • Loading branch information
dopplershift committed Aug 20, 2019
1 parent 7bf9052 commit d903283
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion metpy/calc/indices.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def mean_pressure_weighted(pressure, *args, **kwargs):
----------
pressure : `pint.Quantity`
Atmospheric pressure profile
*args : `pint.Quantity`
args : `pint.Quantity`
Parameters for which the pressure-weighted mean is to be calculated.
heights : `pint.Quantity`, optional
Heights from sounding. Standard atmosphere heights assumed (if needed)
Expand Down
3 changes: 1 addition & 2 deletions metpy/calc/thermo.py
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,7 @@ def dry_lapse(pressure, temperature, ref_pressure=None):
See Also
--------
moist_lapse : Calculate parcel temperature assuming liquid saturation
processes
moist_lapse : Calculate parcel temperature assuming liquid saturation processes
parcel_profile : Calculate complete parcel profile
potential_temperature
Expand Down
4 changes: 2 additions & 2 deletions metpy/calc/tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ def get_layer_heights(heights, depth, *args, **kwargs):
Atmospheric heights
depth : `pint.Quantity`
The thickness of the layer
*args : array-like
args : array-like
Atmospheric variable(s) measured at the given pressures
bottom : `pint.Quantity`, optional
The bottom of the layer
Expand Down Expand Up @@ -530,7 +530,7 @@ def get_layer(pressure, *args, **kwargs):
----------
pressure : array-like
Atmospheric pressure profile
*args : array-like
args : array-like
Atmospheric variable(s) measured at the given pressures
heights: array-like, optional
Atmospheric heights corresponding to the given pressures. Defaults to using
Expand Down
4 changes: 2 additions & 2 deletions metpy/deprecation.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
5. MDT SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
MATPLOTLIB , OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
THE POSSIBILITY THEREOF.
Expand Down Expand Up @@ -82,7 +82,7 @@
WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
5. JDH SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
MATPLOTLIB , OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
THE POSSIBILITY THEREOF.
Expand Down
3 changes: 2 additions & 1 deletion metpy/testing.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ def get_upper_air_data(date, station):
"""Get upper air observations from the test data cache.
Parameters
----------
----------
time : datetime
The date and time of the desired observation.
station : str
The three letter ICAO identifier of the station for which data should be
downloaded.
Returns
-------
dict : upper air data
Expand Down
9 changes: 5 additions & 4 deletions metpy/units.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,17 +228,18 @@ def masked_array(data, data_units=None, **kwargs):
This is a thin wrapper around :func:`numpy.ma.masked_array` that ensures that
units are properly attached to the result (otherwise units are silently lost). Units
are taken from the ``units`` argument, or if this is ``None``, the units on ``data``
are taken from the ``data_units`` argument, or if this is ``None``, the units on ``data``
are used.
Parameters
----------
data : array_like
The source data. If ``units`` is `None`, this should be a `pint.Quantity` with
The source data. If ``data_units`` is `None`, this should be a `pint.Quantity` with
the desired units.
data_units : str or `pint.Unit`
data_units : str or `pint.Unit`, optional
The units for the resulting `pint.Quantity`
**kwargs : Arbitrary keyword arguments passed to `numpy.ma.masked_array`
kwargs
Arbitrary keyword arguments passed to `numpy.ma.masked_array`, optional
Returns
-------
Expand Down

0 comments on commit d903283

Please sign in to comment.