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...

More Python Development prompts

• Convert Python functions to lambda expressions.
• Create comments for Python code.
• Create Python regular expressions.
• Generate a Python function signature.
• Generate professional Python script headers.
• Generate setup files for a Python package.

More in Software Development

• Create professional error messages for technical systems. (Systems Analysis)
• Generate a technical comment for a function. (Backend Development)
• Compose a professional stakeholder update email. (IT Project Management)
• Create a professional About Us page. (Website Design)
• Create a technical FAQ for a blockchain application. (Blockchain Development)
• Create precise technical error messages. (Backend Development)