What is the 'Security Note' section?

The Security Note is a specialized section used when a function handles sensitive data like PII, credentials, or financial information to ensure developers are aware of security constraints.

Can this skill help with API documentation?

Absolutely. It includes a specific 'Tool/API' format that documents search queries, category filters, and example JSON responses for better API clarity.

Which docstring style does this skill support?

This skill specifically enforces the Google Python Style Guide format, which is one of the most popular and readable standards for Python documentation.

Does it work with class properties and async functions?

Yes, it includes specific patterns for class constructors, @property decorators (including setters), and asynchronous functions.

Google Docstring Enforcer

Name: Google Docstring Enforcer
Author: ricardoroche

byricardoroche

Learning & Documentation

Enforces standardized Google-style documentation for Python functions, classes, and properties with specialized security and example sections.

About

The Docstring Format Enforcer ensures your Python codebase maintains a high standard of documentation by automatically applying the Google-style docstring format. It structures code comments into clear sections including Args, Returns, Raises, and Examples, while uniquely supporting 'Security Notes' for functions handling sensitive data. This skill is essential for teams aiming for consistent, readable, and professional code that integrates perfectly with automated documentation generators and improves developer onboarding.

Key Features

Automated section generation for Args, Returns, and Raises
0 GitHub stars
Security Note integration for PII and sensitive operations
Support for async functions, properties, and class attributes
Google-style docstring standardization
Example and Example Response block formatting

Use Cases

Standardizing documentation across a legacy Python codebase
Documenting security-sensitive API functions and payment logic
Improving code maintainability through consistent docstring patterns

About

Key Features

Automated section generation for Args, Returns, and Raises
0 GitHub stars
Security Note integration for PII and sensitive operations
Support for async functions, properties, and class attributes
Google-style docstring standardization
Example and Example Response block formatting

Use Cases

Standardizing documentation across a legacy Python codebase
Documenting security-sensitive API functions and payment logic
Improving code maintainability through consistent docstring patterns