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

0•

Learning & Documentation

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

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

01Automated section generation for Args, Returns, and Raises

020 GitHub stars

03Security Note integration for PII and sensitive operations

04Support for async functions, properties, and class attributes

05Google-style docstring standardization

06Example and Example Response block formatting

Use Cases

01Standardizing documentation across a legacy Python codebase

02Documenting security-sensitive API functions and payment logic

03Improving code maintainability through consistent docstring patterns

Key Features

01Automated section generation for Args, Returns, and Raises

020 GitHub stars

03Security Note integration for PII and sensitive operations

04Support for async functions, properties, and class attributes

05Google-style docstring standardization

06Example and Example Response block formatting

Use Cases

01Standardizing documentation across a legacy Python codebase

02Documenting security-sensitive API functions and payment logic

03Improving code maintainability through consistent docstring patterns