python-docs SKILL.md skillA
python-docs from bitwise-media-group/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add bitwise-media-group/skills/python-docs@git:20260701.89b4f1fPins git:20260701.89b4f1f in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- bitwise-media-group/skills
- Path
plugins/python/skills/python-docs/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260701.89b4f1f, committed Jul 1, 2026
- Size
- 3,490 bytes
- Repository stars
- 3
- License
- MIT
Python documentation conventions — a Google-style docstring on every public module, class, and function, enforced by ruff's pydocstyle (D) rules with the google convention, and LLM-ready markdown CLI reference generation for Click or Typer tools via a reproducible docgen helper. Use when writing or reviewing docstrings, choosing or enforcing a docstring style, configuring ruff's D rules, deciding where module or package docstrings belong, or generating markdown CLI documentation for a…
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
# Python documentation conventions
Docstrings are the API's reference manual: editors, `help()`, and doc generators render them, and
LLM coding agents read them to learn an API. These rules say where they go, what style they take,
and how the linter enforces them. For the code itself see the `python-style` skill.
## 1. A docstring on every public API, Google style
Every public module, class, function, and method carries a docstring; private (`_`-prefixed) and
trivial dunder methods do not need one. Use **Google style** — a one-line imperative summary, then
`Args:`, `Returns:`, `Raises:` as needed:
```python
def parse(line: str) -> tuple[str, str]:
"""Split a KEY=VALUE line into its key and value.
Args:
line: A single ``key=value`` pair; whitespace around each side is trimmed.
Returns:
The ``(key, value)`` pair.
Raises:
ValueError: If the separator is missing or the key is empty.
"""
```
Document behavior and invariants the caller can rely on, not the implementation. Types live in the
annotations (see `python-typing`), so do not repeat them in the docstring prose.
## 2. Module and package docstrings
…Read the whole file at its exact version.
How to install
mdr add bitwise-media-group/skills/python-docs@sha256:f49b91c082190fdfThe line at the top of this page pins the label git:20260701.89b4f1f, 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_xfn3lowcd5t4dqym)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jul 1, 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 (3490 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
bitwise-media-group/skills · 3 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_xfn3lowcd5t4dqym GET https://markdownregistry.com/api/v1/resolve?ref=bitwise-media-group/skills/python-docs GET https://markdownregistry.com/api/v1/blob/f49b91c082190fdf3ba2c18ef766f55ac7c68a6dc99ed1e859108d2e54ecef1f
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.