Just a line about what the function is expected to do along with any parameters it accepts.
Although functions should be self-documenting docstrings serve future Kevin by giving him plain text to read when maintaining this code, plus its good practice.
Write timeless docstrings by stating the single reason the function was written.
Just a line about what the function is expected to do along with any parameters it accepts. Although functions should be self-documenting docstrings serve future Kevin by giving him plain text to read when maintaining this code, plus its good practice.
Write timeless docstrings by stating the single reason the function was written.