What are some common mistakes in writing docstrings?

What are some common mistakes in writing docstrings?

Some common mistakes include being too vague, not following conventions, and failing to update them when code changes.

Can you give examples of vague docstrings?

Sure! A vague docstring might say 'This function does something' instead of explaining what the function actually does.

What conventions should I follow for writing docstrings?

You should follow PEP 257 for Python, which includes guidelines like using triple quotes and including parameters and return types.

How often should I update docstrings?

You should update docstrings whenever you change the functionality of the code or when you add new features.