ReddRadar
Agent skill
document-python-component
Write or upgrade conventional Python docstrings for public modules, classes, functions, methods, and properties. Docstrings must be user-facing, mkdocstrings-friendly, include runnable examples, and must not repeat type hints.
Install this agent skill to your Project
npx add-skill https://github.com/NightingaleV/agentic-dev-env/tree/main/src/base/skills/docstring-python
Metadata
Additional technical details for this skill
- keywords
-
python docstrings google-style mkdocs mkdocstrings mkdocs-material
- short description
- Google-style docstrings for public Python APIs (mkdocstrings-ready)
SKILL.md
Trigger conditions
Use this skill when you:
- Add or modify a public module/class/function/method/property
- See missing, vague, outdated, or inconsistent docstrings
- Prepare code for API docs (mkdocstrings pages)
- Introduce non-obvious behavior, edge cases, or side effects
{% include 'docs/python_docstring.md' %}
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
NightingaleV/agentic-dev-env
brand-guidelines
Applies PwC's official brand colors and typography to any sort of artifact that may benefit from having PwC's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.
NightingaleV/agentic-dev-env
document-python-component
Write or upgrade conventional Python docstrings for public modules, classes, functions, methods, and properties. Docstrings must be user-facing, mkdocstrings-friendly, include runnable examples, and must not repeat type hints.
mattpocock/skills
setup-pre-commit
Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and tests in the current repo. Use when user wants to add pre-commit hooks, set up Husky, configure lint-staged, or add commit-time formatting/typechecking/testing.
mattpocock/skills
scaffold-exercises
Create exercise directory structures with sections, problems, solutions, and explainers that pass linting. Use when user wants to scaffold exercises, create exercise stubs, or set up a new course section.
mattpocock/skills
handoff
Compact the current conversation into a handoff document for another agent to pick up.
mattpocock/skills
obsidian-vault
Search, create, and manage notes in the Obsidian vault with wikilinks and index notes. Use when user wants to find, create, or organize notes in Obsidian.
Didn't find tool you were looking for?