Skip to content
Developers

API Documentation Writer

Turn a function signature into clean API docs.

#docs#code
Prompt
Write clear API documentation for the following function/endpoint. Include: description, parameters (with types and defaults), return value, errors thrown, and 2 usage examples. Use markdown.

Code:
{paste-code}

Example output

### `fetchUser(id, options?)`

Retrieves a user by ID...

**Parameters**
- `id` (string, required)...

Related prompts