From docs-guardian
Detects public APIs via __all__ and conventions, audits docstring completeness, parses Google/NumPy/Sphinx formats for Python functions/classes/methods.
How this skill is triggered — by the user, by Claude, or both
Slash command
/docs-guardian:lang-pythonThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
A symbol is **public** if:
A symbol is public if:
__all__ (if __all__ exists, only listed names are public)_ (single underscore = internal convention)__all__ exists → only those names are public__all__ does not exist → all non-underscore module-level names are public| Type | Detection | Documentation Expected |
|---|---|---|
| Functions | def name( at module level | Docstring with params, returns, raises |
| Classes | class Name: or class Name(Base): | Class docstring + __init__ params |
| Methods | def name(self inside class, not _-prefixed | Docstring with params, returns |
| Constants | NAME = value (UPPER_CASE at module level) | Inline comment or module docstring mention |
| Type aliases | Name = TypeAlias or type Name = ... | Docstring or inline comment |
Recognize and parse these formats:
def foo(bar: int, baz: str) -> bool:
"""One-line summary.
Args:
bar: Description of bar.
baz: Description of baz.
Returns:
True if successful.
Raises:
ValueError: If bar is negative.
"""
def foo(bar, baz):
"""One-line summary.
Parameters
----------
bar : int
Description of bar.
baz : str
Description of baz.
Returns
-------
bool
True if successful.
"""
def foo(bar, baz):
"""One-line summary.
:param bar: Description of bar.
:type bar: int
:param baz: Description of baz.
:returns: True if successful.
:raises ValueError: If bar is negative.
"""
A Python symbol is fully documented when:
None)raise statements exist)Source files: **/*.py (exclude __pycache__, *.pyc, test files)
npx claudepluginhub xiaolai/claude-plugin-marketplace --plugin docs-guardianFetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Provides a checklist for code reviews covering functionality, security, performance, maintainability, tests, and quality. Use for pull requests, audits, team standards, and developer training.