// Use when writing, auditing, or generating documentation for Python projects — covers docstring conventions, API doc extraction, and Python-specific patterns.
| name | lang-python |
| description | Use when writing, auditing, or generating documentation for Python projects — covers docstring conventions, API doc extraction, and Python-specific patterns. |
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)
Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in plain Markdown format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in Sphinx format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in VitePress format — covers config, directory structure, frontmatter conventions, and build commands.
Use when writing, auditing, or generating documentation for projects in unsupported languages — covers docstring conventions, API doc extraction, and generic heuristic patterns.