How do I write docstrings for my Python functions?

How do I write docstrings for my Python functions?

To write a docstring for a Python function, place a string literal right after the function definition. It should describe what the function does, its parameters, and its return value.

Can you give me an example of a docstring?

Sure! Here's an example:

def add(a, b):
    """
    Add two numbers.

    Parameters:
    a (int or float): The first number.
    b (int or float): The second number.

    Returns:
    int or float: The sum of a and b.
    """
    return a + b

What if my function has no parameters?

If your function has no parameters, you can simply describe what the function does in the docstring. For example:

def greet():
    """
    Print a greeting message.
    """
    print('Hello, world!')

Are there any conventions I should follow?

Yes! Follow PEP 257 conventions, use triple quotes, and keep the first line short and descriptive. Include details about parameters and return values if applicable.