GO

google-docstring-assistant

Assists in writing Python docstrings following the Google Style Guide.

Install

mkdir -p .claude/skills/google-docstring-assistant && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/18091" && unzip -o skill.zip -d .claude/skills/google-docstring-assistant && rm skill.zip

Installs to .claude/skills/google-docstring-assistant

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Write Python docstrings following the Google Python Style Guide, using clear sections and examples.
99 charsno explicit “when” trigger
Beginner

Key capabilities

  • →Write docstrings following Google Python Style Guide
  • →Include `Args`, `Returns`, and `Raises` sections for functions
  • →Use `Attributes` and `Todo` sections for modules/classes
  • →Format `Examples` blocks with literal blocks for code snippets
  • →Document module-level variables consistently
  • →Keep docstrings concise and informative

How it works

The skill guides the user to write Python docstrings according to the Google Python Style Guide, ensuring clear sections and examples.

Inputs & outputs

You give it
Python code requiring docstrings
You get back
Formatted Python docstrings adhering to Google style

When to use google-docstring-assistant

  • →Document a function
  • →Generate class attributes doc
  • →Add examples to documentation
  • →Standardize docstring style

About google-docstring-assistant

Guides the creation of consistent, informative Python docstrings including Args, Returns, and Examples sections to improve code readability.

Write Python docstrings following the Google Python Style Guide, using clear sections and examples.

When not to use it

  • →When types are annotated in code and clarity is not improved by repeating them in docstrings
  • →When using non-Google-style wording

Limitations

  • →Does not automatically generate docstrings
  • →Requires manual selection of sections
  • →Requires manual writing of clear and concise content

How it compares

This skill enforces a specific, consistent style for Python docstrings, improving readability and maintainability compared to ad-hoc documentation.

Compared to similar skills

google-docstring-assistant side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
google-docstring-assistant (this skill)05moNo flagsBeginner
agent-implementer-sparc-coder18moReviewIntermediate
nia-docs19moReviewBeginner
skills05moReviewIntermediate

Try saying

Example prompts that trigger this skill in your AI assistant.

Search skills

Search the agent skills registry