Prompt · Developer Tools

Docstring Writer

Writes clear, complete API documentation for pasted functions or classes.

Have ready: Paste the function or class to document

Fill in · 3 fields

DOCSTYLE, e.g. Google-style Python docstrings / JSDoc / TSDoc / rustdocPASTE THE FUNCTION, CLASS, OR MODULEUNKNOWN, ASK AUTHOR

Your prompt

Write documentation for the following code in [DOCSTYLE, e.g. Google-style Python docstrings / JSDoc / TSDoc / rustdoc].

Code:
[PASTE THE FUNCTION, CLASS, OR MODULE]

Include:
- A one-line summary plus a paragraph for anything non-obvious.
- Every parameter: type, meaning, valid range/default, and what happens on invalid input.
- Return value and every exception/error it can raise, with when each occurs.
- One short usage example that actually runs.
- Anything a caller must know: thread-safety, side effects, performance characteristics, deprecation notes.

If any of that is unknowable from the code alone, write [UNKNOWN, ASK AUTHOR] instead of guessing.

Paste it into Muse or any assistant. Blank fields stay as [brackets].

More like this