What are Python function docstrings and how do I use them?

What are Python function docstrings?

Python function docstrings are string literals that appear right after the function definition. They describe what the function does.

How do I write a docstring for my function?

You can write a docstring by placing a string in triple quotes right after the function header. For example:

def my_function(): """This function does something amazing."""

Are there any conventions I should follow when writing docstrings?

Yes, it's recommended to follow the PEP 257 conventions, which include using triple double quotes and providing a summary of the function's purpose.

Can you show me an example of a well-documented function?

Sure! Here's an example:

def add(a, b): """Return the sum of a and b.

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