Python docstrings examples

Python Clean Code Tip:

Use docstrings to document usage of your modules, classes, and functions.

The temperature module: Manipulate your temperature easily

Easily calculate daily average temperature

from typing import List

class HighTemperature:
    """Class representing very high temperatures"""

    def __init__(self, value: float):
        :param value: value of temperature

        self.value = value

def daily_average(temperatures: List[float]) -> float:
    Get average daily temperature

    Calculate average temperature from multiple measurements

    :param temperatures: list of temperatures
    :return: average temperature

    return sum(temperatures) / len(temperatures)