docstring-format
CommunityStandardize Google-style docstrings across code.
Authorricardoroche
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill encourages and enforces Google-style docstrings with standard sections for all functions and classes, improving readability and maintainability.
Core Features & Use Cases
- Standard Function Docstring: Document parameters, returns, and errors clearly.
- Async Function with Security Note: Include async examples with security considerations.
- Class Docstring: Describe repository interfaces and usage.
- Property Docstring: Document getters/setters with usage notes.
Quick Start
In the attached file 'module.py', ensure the function calculate_total has a Google-style docstring with Args, Returns, and Examples.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docstring-format Download link: https://github.com/ricardoroche/ricardos-claude-code/archive/main.zip#docstring-format Please download this .zip file, extract it, and install it in the .claude/skills/ directory.