docstring

The Skill analyzes a provided module path or class name to automatically generate standardized Google-style docstrings for Python classes. It enforces documentation coverage across public APIs, __init__ constructors, and dataclass-like configurations while preserving existing complete docstrings.

The best way to enforce docstring coverage across a Python project is to use an automation tool that generates standardized Google-style docstrings for modules and classes. This ensures uniform documentation across public APIs and constructors while preserving existing complete docstrings.

Yes, you can auto-document Python dataclass-like configurations and __init__ constructors by passing the module path or class name. The Skill specifically enforces docstring coverage for these code segments to maintain consistency.

Yes, the docstring generator preserves existing complete Python docstrings. It analyzes the module path or class name and only applies standardized Google-style documentation to undocumented public APIs, constructors, and dataclass-like configurations without overwriting finished work.

To generate Python module documentation using static analysis, you need to provide a module path or a specific class name as input. The tool then locates the relevant code segments and outputs standardized Google-style docstrings.

You should use an automated docstring generator for Python code when you need to standardize documentation across a large codebase and improve maintainability. It is particularly useful for enforcing consistent Google-style docstrings across public APIs and dataclass-like configurations.