docstrings
Use when the user invokes /docstrings; asks to explain or improve a specific confusing comment or docstring; asks to write, update, review, or audit comments or docstrings; or explicitly includes comments or docstrings in general documentation work. For targeted requests, investigate the related code and explain the named comment or docstring or, when edits are requested, rewrite it clearly following the guidelines and instructions in this skill. For broader requests, audit the requested code for missing documentation around complex or non-obvious behavior; confusing, vague, jargon-heavy, incomplete, or overly detailed explanations; unfamiliar concepts that are not defined; missing purpose, contracts, side effects, returns, or exceptions; and redundant documentation that merely repeats the code. The result should be clear, easy to understand, and quick to read to someone who has never seen the related code or system. Comments default to 1-3 lines and docstrings to 1-8 lines, preferring shorter.
Pinned to revision c412c157399a, so it is the text this page describes rather than whatever the author pushed since.
Files
Every link opens the file at its source, pinned to the revision this page describes.