writing-docstrings SKILL.md skillA
writing-docstrings from ahgraber/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add ahgraber/skills/writing-docstrings@git:20261017.44218caPins git:20261017.44218ca in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- ahgraber/skills
- Path
skills/writing-docstrings/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261017.44218ca, committed Oct 17, 2026
- Size
- 3,561 bytes
- Repository stars
- 6
- License
- CC0-1.0
Use when writing, rewriting, or auditing Python docstrings that a documentation site is generated from, or when docstrings are long, narrate the code, or leave a reader of the generated reference unable to find their way. Triggers - "audit the docstrings", "docstring slop", "docstrings as documentation", "the API reference reads badly", "rewrite these docstrings".
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Writing Docstrings Docstrings that a site is generated from are the product's documentation. Each one states what a reader needs, in a fixed place, in plain language. ## When to Use - A documentation site (great-docs, quartodoc, mkdocstrings, Sphinx autodoc) renders the package's docstrings. - An audit of docstrings for length, body narration, rationale, history, or vague wording. - A rewrite of docstrings after an API change, where the reference must stay accurate. - A new public function, class, or module needs a docstring that matches the rest. ## When Not to Use - Comments inside a body, or slop in code: use `simplify`. - Narrative documentation pages, tutorials, or a docs site built from prose: use `scaffold-docs`. - Commit messages: use `commit-message`. ## Invocation Notice - Tell the user when this skill is running: `writing-docstrings`. Skip the notice when the user asked for the skill by name or slash command; spelling and spacing need not match. A phrase from this skill's own trigger list is not a name — naming the work is not naming the skill. ## Workflow 1. Find what the site renders. …
Read the whole file at its exact version.
How to install
mdr add ahgraber/skills/writing-docstrings@sha256:8dc4117ea6f6a220The line at the top of this page pins the label git:20261017.44218ca, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_qc67dqn5q6bkk6nd)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 17, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3561 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
ahgraber/skills · 6 stars · license CC0-1.0 · pushed 2026-10-29 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_qc67dqn5q6bkk6nd GET https://markdownregistry.com/api/v1/resolve?ref=ahgraber/skills/writing-docstrings GET https://markdownregistry.com/api/v1/blob/8dc4117ea6f6a2208ef3ae1adcd4fe3cf3232f3d50b36d4d36f16e5c0552c774
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.