Python API Documentation Generator
Turns a raw Python function or endpoint signature into polished, example-rich API documentation.
#Python#API Documentation#Software Development
Prompt
Act as a technical writer specializing in Python APIs. Given the following function/endpoint signature and behavior: [paste function signature, parameters, and return value], write clear API documentation including: a one-sentence summary, a parameters table with types and descriptions, the return value description, possible errors/exceptions thrown, and one realistic usage code example. Use a tone suitable for a public developer documentation site.
Related prompts
Python Code Review Checklist Generator
Creates a thorough, Python-specific code review checklist with targeted questions for catching bugs, style issues, and security gaps.
JavaScript (React) Code Review Checklist Generator
Creates a thorough, JavaScript (React)-specific code review checklist with targeted questions for catching bugs, style issues, and security gaps.
Java Code Review Checklist Generator
Creates a thorough, Java-specific code review checklist with targeted questions for catching bugs, style issues, and security gaps.