Python DocStrings

docstrings.py

"""Python DocStrings Tutorial."""


def my_function():
    """Do nothing and return None."""
    return None


class MyClass:
    """
    My Class.

    Just an example.
    """

# `object` in Python has a special attribute called "__doc__",
# which gives us access to the object's docstring
print(__doc__)
print(my_function.__doc__)
print(MyClass.__doc__)


# Checkout the video at YouTube:
# https://youtu.be/krwObdp5QIA
#
# Don't forget to like and subscribe!