Code Documentation prompts

Docstring writing task for a given Python function

GPT

This prompt is about generating a detailed docstring for a Python function. The audience is a Python developer who might not be familiar with the function. It requires understanding of the Python style guide (PEP 257) and the ability to clearly explain what the function does, its inputs, and outputs.

More details