Function docstrings

Every function or method you create or edit, including tests, fixtures and helpers, needs a docstring with:

• A short description of its purpose.
• Parameters: followed on the same line by each parameter and its meaning. Include self/cls; use Parameters: none for a parameterless function.
• Returns: followed on the same line by the return meaning, or Returns: None.

A long parameter list may continue after that first line has content. Blank lines between sections and a trailing period are fine. Args: and labels whose content starts on the next line do not satisfy this format. Lambdas are exempt.

Write the complete docstring with the function's first saved draft. Before committing, review the functions in every changed source and test file; passing assertions do not verify their documentation. When a later capability widens or changes what a function accepts or returns, its earlier docstring becomes stale in that capability's cycle. Before that commit, reread every docstring in the changed modules and rewrite each phrase that still states the former limit: a type, sign, range, word-count or format restriction. Check the parser, every operation helper and the entrypoint, including helpers whose code did not change in this cycle; a docstring that describes a limit the code no longer enforces fails even when its body is untouched. Description-only test-method docstrings are incomplete: include the receiver in Parameters: and the method's result in Returns:.

def updated_count(value, count):
    """Return the updated count.

    Parameters: value - amount to add; count - current count.
    Returns: the updated count.
    """
    print(f"value={value}, count={count}")
    result = count + value
    print(result)
    return result

The prints illustrate compatibility with selected logging; commenting alone does not require them.