Docstring Formatter

关于

Streamlines the process of maintaining high-quality documentation across Python modules by enforcing consistent NumPy-style formatting. It systematically extracts information from function signatures and existing text to build complete docstrings that include detailed parameter types, return descriptions, exception handling, and executable code examples. This skill is particularly useful for developers preparing codebases for automated API reference generation with Sphinx or improving the maintainability of complex scientific and machine learning libraries where clear documentation is critical.

主要功能

• Automatically extracts parameter names, types, and return values from function signatures.
• 0 GitHub stars
• Converts Google-style and plain-text comments into standardized NumPy docstrings.
• Ensures compliance with Sphinx documentation requirements and pydocstyle guidelines.
• Generates structured sections for Exceptions, Notes, and executable Examples.
• Provides specialized templates for PyTorch modules, properties, and complex scientific functions.

使用场景

• Preparing a Python repository for automated documentation generation using Sphinx.
• Upgrading legacy codebases with inconsistent or missing documentation to a unified standard.
• Documenting complex machine learning models or scientific APIs with clear usage examples.