Upgrade pydocstyle to 5.0.1 (#29830)

* Upgrade pydocstyle to 5.0.1

http://www.pydocstyle.org/en/5.0.1/release_notes.html

* Pydocstyle and other docstring fixes
This commit is contained in:
Ville Skyttä authored and Paulus Schoutsen committed 2019-12-10 23:25:06 +01:00
1 parent 3ed1738f76
commit a12cf7211d
24 files changed
+33 -33

No files matched your search

@@ -66,7 +66,7 @@ class WUSensorConfig:
device_state_attributes=None,
device_class=None,
):
"""Constructor.
"""Initialize sensor configuration.
:param friendly_name: Friendly name
:param feature: WU feature. See:
@@ -98,7 +98,7 @@ class WUCurrentConditionsSensorConfig(WUSensorConfig):
unit_of_measurement: Optional[str] = None,
device_class=None,
):
"""Constructor.
"""Initialize current conditions sensor configuration.
:param friendly_name: Friendly name of sensor
:field: Field name in the "current_observation" dictionary.
@@ -127,7 +127,7 @@ class WUDailyTextForecastSensorConfig(WUSensorConfig):
def __init__(
self, period: int, field: str, unit_of_measurement: Optional[str] = None
):
"""Constructor.
"""Initialize daily text forecast sensor configuration.
:param period: forecast period number
:param field: field name to use as value
@@ -164,7 +164,7 @@ class WUDailySimpleForecastSensorConfig(WUSensorConfig):
icon=None,
device_class=None,
):
"""Constructor.
"""Initialize daily simple forecast sensor configuration.
:param friendly_name: friendly_name of the sensor
:param period: forecast period number
@@ -207,7 +207,7 @@ class WUHourlyForecastSensorConfig(WUSensorConfig):
"""Helper for defining sensor configurations for hourly text forecasts."""
def __init__(self, period: int, field: int):
"""Constructor.
"""Initialize hourly forecast sensor configuration.
:param period: forecast period number
:param field: field name to use as value
@@ -274,7 +274,7 @@ class WUAlmanacSensorConfig(WUSensorConfig):
icon: str,
device_class=None,
):
"""Constructor.
"""Initialize almanac sensor configuration.
:param friendly_name: Friendly name
:param field: value name returned in 'almanac' dict as returned by the WU API
@@ -297,7 +297,7 @@ class WUAlertsSensorConfig(WUSensorConfig):
"""Helper for defining field configuration for alerts."""
def __init__(self, friendly_name: Union[str, Callable]):
"""Constructor.
"""Initialiize alerts sensor configuration.
:param friendly_name: Friendly name
"""