generate-docstrings

Generate docstrings by using templates that follow standard formats like Google-style, NumPy-style, or reStructuredText. This Skill creates comprehensive docstrings with parameter descriptions, return types, exceptions, and usage examples to ensure API documentation consistency across your codebase.

Docstrings for API documentation should include a one-line summary, parameter names and types, descriptions of each parameter, return value and type, raised exceptions, and practical usage examples. This Skill generates all these components in structured formats recognized by documentation generators.

Yes. This Skill supports multiple documentation formats—Google-style, NumPy-style, and reStructuredText—so you can generate consistently formatted docstrings regardless of which standard your project uses.

When adding or updating code, use this Skill to generate docstring templates with all required sections pre-structured. This ensures new documentation follows your project's established format and includes all necessary API details without manual formatting.

This Skill supports both Python and Mojo, generating appropriately formatted docstrings for functions and classes in either language following the same documentation standards.

Use this Skill to automate docstring generation for multiple functions and classes at once, eliminating repetitive manual writing. Batch generation ensures consistent formatting and complete documentation coverage across your entire codebase.