auto-docstring-rules

You can enforce Python docstring conventions by applying rules that check for Google style format, ensuring concise descriptions and proper use of Args, Returns, Yields, and Raises sections in functions and classes.

The Google style guide for Python docstrings is a format standard that requires concise short-form and full-form descriptions, specific field docstrings, and structured sections like Args, Returns, Yields, and Raises to improve code readability.

To check docstrings for anti-patterns during code review, validate the modified function signatures and class definitions against established Google style guidelines to identify and prevent stylistic inconsistencies.

Yes, you can use this to review field docstrings and function signatures, as it specifically applies to writing or modifying these elements to ensure they adhere to the required dlt docstring conventions.

Common anti-patterns when writing Python docstrings include inconsistent formatting, missing Args or Returns sections, and overly verbose descriptions that deviate from the established Google style short-form and full-form guidelines.