Generate professional Python docstrings.

Create clear and accurate docstrings for specific Python functions using industry-standard technical writing.

Prompt

Act as an expert Python Developer specializing in high-quality software documentation. Your task is to write a precise docstring for the following function: {{PASTE YOUR PYTHON FUNCTION HERE}}. Adhere to a technical writing style that is objective, clear, and logically organized. Ensure the documentation is accurate and industry-specific, avoiding any fabrication, personal opinion, or unnecessary jargon. Maintain high efficiency in communication and provide the final output in {{INPUT THE OUT...