Agent skill

Python Docstrings

by open-edge-platform in open-edge-platform/anomalib

Enforces Google-style Python docstrings for Python code. An agent skill from open-edge-platform/anomalib.

Apache-2.0Auto-check passedDevelopment

Install Python Docstrings

skills CLI
$ npx skills add open-edge-platform/anomalib --skill python-docstrings -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install open-edge-platform/anomalib python-docstrings --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/open-edge-platform/anomalib.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/python-docstrings .claude/skills/python-docstrings && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
python-docstrings
GitHub stars
6.2k
Token cost
~571 tokens
SKILL.md length
188 words
Files
1
Skills in repo
17
Repo updated
First seen
Licence
Apache-2.0

At a glance

Enforces Google-style Python docstrings for Python code. An agent skill from open-edge-platform/anomalib.

  • Works in 6 steps: Short description → Optional longer explanation → Args → …
  • Tasks that involve Technical documentation
  • SKILL.md covers Purpose and scope, Request changes when, Required structure and Formatting rules, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Python Docstrings is an agent skill from open-edge-platform/anomalib. Enforces Google-style Python docstrings for Python code

Its SKILL.md is about 570 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. It works with Python. The repository describes itself as: An anomaly detection library comprising state-of-the-art algorithms and features such as experiment management, hyper-parameter optimization, and edge inference. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “Use the python-docstrings skill to enforce Google-style Python docstrings for Python code. An agent skill from open-edge-platform/anomalib”
  • “/python-docstrings”

Requirements

  • Python 3

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Short description
  2. Optional longer explanation
  3. Args
  4. Returns
  5. Optional Raises
  6. Optional Example

What it can do on your machine

Read from SKILL.md and the folder at commit 4807ef1. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are python).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Python Docstrings loads about 571 tokens when it runs. Until then it costs about 18 tokens; SKILL.md has 188 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~18
When it runs · the whole SKILL.md, loaded when a task matches
~571

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from open-edge-platform/anomalib at commit 4807ef1, republished under its Apache-2.0 licence (© open-edge-platform). 188 words, ~571 tokens.

Download SKILL.mdSave it as .claude/skills/python-docstrings/SKILL.md (or your agent's skills folder).
name
python-docstrings
description
Enforces Google-style Python docstrings for Python code

Python Docstring Rules

Use this skill when reviewing or writing Python docstrings.

Purpose and scope

  • Use Google-style docstrings.
  • Focus on public Python modules, classes, functions, and methods.
  • Keep docstrings compact, specific, and easy to scan.

Request changes when

  • a public API has no docstring;
  • the summary line is vague or inaccurate;
  • arguments, returns, or intentionally raised exceptions are undocumented;
  • a non-trivial public API needs an example but does not have one.

Required structure

  1. Short description
  2. Optional longer explanation
  3. Args
  4. Returns
  5. Optional Raises
  6. Optional Example

Formatting rules

  • Limit docstrings to 120 characters per line.
  • In Args, use name (type): description.
  • In Returns, describe both the type and meaning of the returned value.
  • Add Raises when the function intentionally raises exceptions.
  • Use doctest-style Example blocks with >>> when examples help clarify usage.

Reviewer checklist

  • Is the docstring present on the public API?
  • Is the summary line accurate?
  • Are inputs, outputs, and exceptions documented?
  • Would a user understand how to call this API from the docstring alone?

Example

python
def my_function(param1: int, param2: str = "default") -> bool:
    """Short description.

    A longer explanation.

    Args:
        param1 (int): Explanation of param1.
        param2 (str): Explanation of param2. Defaults to "default".

    Returns:
        bool: Explanation of the return value.

    Example:
        >>> my_function(1, "test")
        True
    """
    return True

Docstring for __init__ method

  • Document constructor arguments in the class docstring rather than in a separate __init__ docstring.
python
class MyClass:
    """My class description.

    A longer explanation.

    Args:
        param1 (int): Description of param1.
        param2 (str): Description of param2.

    Example:
        >>> my_class = MyClass(param1=1, param2="test")
        >>> my_class.param1
        1
        >>> my_class.param2
        'test'
    """
    def __init__(self, param1: int, param2: str) -> None:
        ...

© open-edge-platform, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/python-docstrings of open-edge-platform/anomalib.

Open the folder on GitHubat commit 4807ef1

Compare with similar skills

Python Docstrings next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Python Docstrings compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Python Docstrings this skillopen-edge-platform/anomalib6.2k—~571Automated safety check: PassApache-2.0
Adk Sample Creatorgoogle/adk-python22k—~1.3kAutomated safety check: PassApache-2.0
Crafting Effective Readmescumbucadev/cinemaempoa1465 repos~669Automated safety check: PassGPL-3.0
Acquire Codebase Knowledgegithub/awesome-copilot40k1 repos~2.3kAutomated safety check: PassMIT
Docs Conventionsflet-dev/flet17k—~1.6kAutomated safety check: PassApache-2.0
DDNS Provider DevelopmentNewFuture/DDNS4.7k—~558Automated safety check: PassMIT

Similar skills

  • Adk Sample Creator

    google/adk-python

    Official

    Creates a new sample agent in the ADK Python repository — the sample directory, its agent.py, and its README.md — following the conventions the existing samples already use.

    22k GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed
  • Crafting Effective Readmes

    cumbucadev/cinemaempoa

    A skill your agent uses when writing or improving README files.

    146 GitHub starsUsed in 5 repos~669 tokens
    DevelopmentAuto-check passed
  • Acquire Codebase Knowledge

    github/awesome-copilot

    Official

    Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    DevelopmentAuto-check passed
  • Docs Conventions

    flet-dev/flet

    A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…

    17k GitHub stars~1.6k tokensUpdated today
    DevelopmentAuto-check passed
  • Adds or changes a DNS provider in the DDNS project while keeping its code, schemas, tests and Chinese and English docs consistent.

    4.7k GitHub stars~558 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Mkdocs

    jeka-dev/jeka

    MkDocs documentation project reference covering CLI commands, mkdocs.yml configuration, Material theme setup, and plugin integration.

    176 GitHub stars~2k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed

More from open-edge-platform/anomalib

All 17 skills in this repo
  • Anomalib Adding A Datamodule

    open-edge-platform/anomalib

    Adds a new dataset/datamodule to anomalib under src/anomalib/data/.

    6.2k GitHub stars~3.7k tokensUpdated today
    Auto-check passed
  • Anomalib Adding A Model

    open-edge-platform/anomalib

    Adds a new anomaly-detection model to anomalib under src/anomalib/models/.

    6.2k GitHub stars~1.9k tokensUpdated today
    Auto-check passed
  • Anomalib Benchmarking

    open-edge-platform/anomalib

    Runs the anomalib benchmarking pipeline to train/evaluate a grid of model + dataset (+ category) combinations and collect metrics into a results CSV.

    6.2k GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Anomalib Tiled Ensemble

    open-edge-platform/anomalib

    Runs and configures the anomalib tiled-ensemble pipeline, which trains/evaluates one model per image tile and merges results (with optional seam smoothing) for high-resolution anomaly detection.

    6.2k GitHub stars~1.4k tokensUpdated today
    Auto-check passed
  • Anomalib Training

    open-edge-platform/anomalib

    Trains an anomalib model on a dataset via the Python API or CLI, including training on a custom folder-structured dataset with the Folder datamodule.

    6.2k GitHub stars~1.4k tokensUpdated today
    Auto-check passed
  • Model Sample Image Export

    open-edge-platform/anomalib

    Export, validate, and publish model sample-result images into docs/source/images and reference them from README/docs pages.

    6.2k GitHub stars~874 tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Python Docstrings

What does Python Docstrings do?

Enforces Google-style Python docstrings for Python code. An agent skill from open-edge-platform/anomalib. Python Docstrings is an agent skill from open-edge-platform/anomalib.

When should I use Python Docstrings?

Python Docstrings fits situations like: tasks that involve Technical documentation.

How do I install Python Docstrings in Claude Code?

Run `npx skills add open-edge-platform/anomalib --skill python-docstrings -a claude-code`. Or copy the skill folder (.agents/skills/python-docstrings in open-edge-platform/anomalib) into .claude/skills/python-docstrings in your project. Claude Code loads it when a task matches its description.

How do I install Python Docstrings in Codex?

Run `npx skills add open-edge-platform/anomalib --skill python-docstrings -a codex`. Or copy the skill folder (.agents/skills/python-docstrings in open-edge-platform/anomalib) into .agents/skills/python-docstrings in your project. Codex loads it when a task matches its description.

Can I use Python Docstrings in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add open-edge-platform/anomalib --skill python-docstrings -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/python-docstrings, .gemini/skills/python-docstrings, .github/skills/python-docstrings and .opencode/skills/python-docstrings in your project.

What does Python Docstrings need to run?

SKILL.md names no scripts, command-line tools or credentials: Python Docstrings is instructions for the agent only. Our summary lists: Python 3.

Does Python Docstrings access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Python Docstrings safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Python Docstrings use?

Python Docstrings is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Python Docstrings use?

About 571 tokens (SKILL.md is roughly 2.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Python Docstrings?

Skills that share tags, products or a category with Python Docstrings: Adk Sample Creator (google/adk-python, 22k stars), Crafting Effective Readmes (cumbucadev/cinemaempoa, 146 stars), Acquire Codebase Knowledge (github/awesome-copilot, 40k stars) and Docs Conventions (flet-dev/flet, 17k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Python Docstrings?

open-edge-platform (a GitHub organization) maintains it in open-edge-platform/anomalib, which has 6,227 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on October 7, 2026.

Source: open-edge-platform/anomalib on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.