← ClaudeAtlas

commentinglisted

Use whenever writing or editing Python (or other) functions: every function must have a docstring with a description, Parameters, and Returns in exactly that format. Apply on every coding task, including new files from scratch.
mikaeltorni/programming_prompts · ★ 1 · Code & Development · score 72
Install: claude install-skill mikaeltorni/programming_prompts
# Function commenting Document every function or method with a docstring that always uses exactly this format: 1. A short description of what the function does. 2. One line starting with `Parameters:` listing each parameter and meaning (`Parameters: none` or `Parameters: None` when there are no parameters). 3. One line starting with `Returns:` describing the return value (`Returns: None` when there is no meaningful return). Do not use `Args:` or other section names. Keep `Parameters:` and `Returns:` as single lines (do not wrap the label onto a following line). Match this layout exactly: ```text """Describes the function. Parameters: name - meaning of name; count - meaning of count. Returns: meaning of the return value. """ ```