Automated summary

Writes Python docstrings that follow the Google Python Style Guide, with clear sections and examples.

Strengths

Enforces section-based structure such as Args, Returns, Raises, Attributes, and Todo
Avoids duplicating type information already provided by annotations when it adds no clarity
Shows how to include literal example blocks for code snippets or commands
Covers docstrings for functions, modules, and classes

Limitations

Covers only Google style, not NumPy or Sphinx formats
Does not validate or automatically reformat docstrings
Relies on an external reference file for the full rules and examples

When to use it

Use it when writing or reviewing Python docstrings that should follow the Google Python Style Guide.

When not to use it

Avoid it when the project requires another docstring format or depends on automated linting for docstring compliance.

Security analysis

Safe

Quality score88/100

The skill provides instructions for writing Python docstrings according to the Google Python Style Guide. It declares no tools and contains no executable commands, destructive actions, network access, or data exfiltration. There is no meaningful execution risk.

No concerns found

How this analysis is made

Examples

Function docstring with Args, Returns, and Raises

Write a Google-style docstring for this Python function, including Args, Returns, and Raises sections:

def parse_config(path):
    ...

Module docstring with Attributes and Todo

Add a Google-style module docstring for this file. Include an Attributes section for the module-level constants and a Todo section for the unfinished caching work.

Convert to Google style with Examples

Convert this existing Python docstring to Google style, keep it concise, and add an Examples section with an indented literal block showing a sample call.

name: google-docstring-assistant description: Write Python docstrings following the Google Python Style Guide, using clear sections and examples.

Google Docstring Assistant

Name: Google Docstring Assistant
Author: Skills Guide Bot

Quick start

Write docstrings using the Google Python Style Guide structure (Args, Returns, Raises, Examples, Attributes, etc.).
Keep sections as headers followed by indented blocks; break sections by resuming unindented text.
When types are annotated in code, omit them in docstrings unless clarity is improved.
Use Examples blocks with literal blocks (::) for commands or code snippets.
Document module-level variables consistently (all in Attributes or inline), and list TODOs in a Todo section.
See references/google_docstring_rules.md for full guidance and examples.

Workflow

Choose sections
- Functions: include Args, Returns, and Raises as needed.
- Modules/classes: use Attributes and Todo when relevant; keep formatting consistent.
Write clearly
- One docstring per object; keep it concise and informative.
- Use indentation under each section header; separate sections by returning to unindented text.
- Prefer Google-style wording; avoid duplicating annotated types unless helpful.
Examples and scripts
- Use Examples: with indented literal blocks for shell commands or code snippets.
- Include multi-line descriptions when needed; keep formatting readable.

Reference

references/google_docstring_rules.md: full style description and examples.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/google-docstring-assistant-mrwak8tn' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/google-docstring-assistant-mrwak8tn/download' --output '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md.part' && mv '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md.part' '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code

test -f '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && test -s '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/google-docstring-assistant' && cp -R '.skill-downloads/google-docstring-assistant-mrwak8tn' '.claude/skills/google-docstring-assistant'

Cursor

test -f '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && test -s '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/google-docstring-assistant' && cp -R '.skill-downloads/google-docstring-assistant-mrwak8tn' '.cursor/skills/google-docstring-assistant'

Codex

test -f '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && test -s '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/google-docstring-assistant' && cp -R '.skill-downloads/google-docstring-assistant-mrwak8tn' '.agents/skills/google-docstring-assistant'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation

openskills install './.skill-downloads/google-docstring-assistant-mrwak8tn'

openskills read 'google-docstring-assistant-mrwak8tn'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544

Skills Guide Bot