Commit bac01398 authored by Niklas Selke's avatar Niklas Selke
Browse files

Added blank lines in docstrings to get properly formatted bullet lists.

parent 95b48c7e
...@@ -105,6 +105,7 @@ def check_statistics(statistics_in): ...@@ -105,6 +105,7 @@ def check_statistics(statistics_in):
:raises TypeError: raised if the statistics parameter is missing or :raises TypeError: raised if the statistics parameter is missing or
not a string or list, set or tuple of strings not a string or list, set or tuple of strings
:raises ValueError: raised if :raises ValueError: raised if
- an empty list, set, tuple or string is given - an empty list, set, tuple or string is given
- any given name is not recognized - any given name is not recognized
- the ``diurnal_cycle`` statistic is not given - the ``diurnal_cycle`` statistic is not given
...@@ -197,12 +198,14 @@ def check_data(data_in, datetimes_in, values_in): ...@@ -197,12 +198,14 @@ def check_data(data_in, datetimes_in, values_in):
:param values_in: the given values parameter :param values_in: the given values parameter
:raises TypeError: raised if :raises TypeError: raised if
- the data parameter is given and not a data - the data parameter is given and not a data
frame or series frame or series
- the index is not a datetime index - the index is not a datetime index
- the values are not in a one-dimensional float - the values are not in a one-dimensional float
or int array or int array
:raises ValueError: raised if :raises ValueError: raised if
- the index is empty, has duplicates or null - the index is empty, has duplicates or null
values values
- the values array is empty or only contains - the values array is empty or only contains
...@@ -314,6 +317,7 @@ def check_metadata(metadata_in, station_lat_in, station_lon_in, ...@@ -314,6 +317,7 @@ def check_metadata(metadata_in, station_lat_in, station_lon_in,
:raises KeyError: raised if any key in the metadata parameter is not :raises KeyError: raised if any key in the metadata parameter is not
recognized recognized
:raises TypeError: raised if :raises TypeError: raised if
- the metadata parameter is given and not a - the metadata parameter is given and not a
dictionary or named tuple dictionary or named tuple
- the station latitude is given and not a float - the station latitude is given and not a float
...@@ -323,6 +327,7 @@ def check_metadata(metadata_in, station_lat_in, station_lon_in, ...@@ -323,6 +327,7 @@ def check_metadata(metadata_in, station_lat_in, station_lon_in,
- the station climatic zone is given and not an - the station climatic zone is given and not an
int or string int or string
:raises ValueError: raised if :raises ValueError: raised if
- the station latitude is given and not - the station latitude is given and not
between -90 and 90 between -90 and 90
- the station longitude is given and not - the station longitude is given and not
...@@ -527,6 +532,7 @@ def check_input_parameters( ...@@ -527,6 +532,7 @@ def check_input_parameters(
:raises TypeError: raised if any parameter has the wrong type or any :raises TypeError: raised if any parameter has the wrong type or any
required parameter is missing required parameter is missing
:raises ValueError: raised if :raises ValueError: raised if
- any parameter has the wrong value - any parameter has the wrong value
- the ``drmdmax1h`` statistic is given - the ``drmdmax1h`` statistic is given
together with ``monthly`` sampling together with ``monthly`` sampling
......
...@@ -98,12 +98,14 @@ def calculate_statistics( ...@@ -98,12 +98,14 @@ def calculate_statistics(
missing in the ``metadata`` argument missing in the ``metadata`` argument
:raises KeyError: raised if :raises KeyError: raised if
- any key in the metadata parameter is not - any key in the metadata parameter is not
recognized recognized
- a growing season is unknown - a growing season is unknown
:raises TypeError: raised if any parameter has the wrong type or any :raises TypeError: raised if any parameter has the wrong type or any
required parameter is missing required parameter is missing
:raises ValueError: raised if :raises ValueError: raised if
- any parameter has the wrong value - any parameter has the wrong value
- the ``drmdmax1h`` statistic is given - the ``drmdmax1h`` statistic is given
together with ``monthly`` sampling together with ``monthly`` sampling
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment