mikaeltorni Function commenting
Document every def / async def / method with a docstring that always
uses exactly this format:
- A short description of what the function does.
- One line starting with
Parameters:listing each parameter and meaning (Parameters: noneorParameters: Nonewhen there are no parameters). - One line starting with
Returns:describing the return value (Returns: Nonewhen there is no meaningful return).
Do not use Args: or other section names. Do not put Parameters: or
Returns: on a line by themselves. A long parameter list may continue on
the next line after the label already has content.
lambda expressions do not need docstrings. Missing docs on a lambda
is not a failure.
Match this layout exactly:
"""Describes the function.
Parameters: name - meaning of name; count - meaning of count.
Returns: meaning of the return value.
"""