do-docstring-format

A documentation rule for public functions and methods. It requires a summary plus details about inputs, outputs, errors, and example values.

In plain words
What is it for?
Use it when writing or reviewing Python docstrings for public functions and methods.
Why use it?
It makes code easier to understand and use by showing what each public function expects and returns, without making readers inspect the implementation first.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/featurefactory-io/mimir/do-docstring-format
Clone the repo
git clone --depth 1 https://github.com/FeatureFactory-io/mimir

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 297 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00297
Opus 5 $0.00000 $0.00148
Sonnet 5 $0.00000 $0.00059
Haiku 4.5 $0.00000 $0.00030

Measured 2d ago against content hash f9e1df83d510, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

do-docstring-format scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/do-docstring-format.mdc · 38 lines

What it actually says

Docstring format (with examples)

Every public function/method needs a docstring in this shape:

def name(p: T) -> R:
    """
    One-line summary.

    :param p: what it is as Type. Example: concrete_value
    :return: what you return as Type. Example: concrete_value
    :raises SomeError: when
    """

Rules: summary line, blank line, then :param / :return / :raises with example values on every param and return (and raises where applicable). Types belong in the signature; docstring repeats them for humans.

Minimal good example

def get_workflow(workflow_id: str) -> dict:
    """
    Load workflow by id.

    :param workflow_id: id as str. Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    :return: workflow dict. Example: {"id": "a1b2c3d4", "name": "Build Feature"}
    :raises ValueError: if id invalid
    """

Anti-patterns: no examples; vague "the name"; missing return example; docstring contradicts implementation (ask user which wins).

**Optional / *args / kwargs: document each; examples show typical values.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 38 lines · 0 tokens per session scan A f9e1df83d510

Subscribe to this mod's changes

do-docstring-format is a cursor rule published in the GitHub repository FeatureFactory-io/mimir (13 stars, last pushed 4d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 297 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.