documentation-standards

documentation-standards is a cursor rule for Cursor from jim-schilling/splurge-ai-rules. It costs 5 tokens per session (148 once invoked), scanned A, original, MIT.

Rules for writing documentation, comments, and Python docstrings. They explain when to document complex logic and what information public Python code should include.

In plain words
What is it for?
Use them when adding or reviewing documentation, comments, and Google-style docstrings for Python functions, classes, and modules.
Why use it?
They keep technical explanations useful and consistent while avoiding unnecessary or outdated comments.

Cursor rule for Cursor

Written for Cursor: installed under .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/jim-schilling/splurge-ai-rules/documentation-standards
Clone the repo
git clone --depth 1 https://github.com/jim-schilling/splurge-ai-rules

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-standards

README.md
[![agentmods](https://agentmods.dev/badge/rules/jim-schilling/splurge-ai-rules/documentation-standards.svg)](https://agentmods.dev/rules/jim-schilling/splurge-ai-rules/documentation-standards)
Your own site
<a href="https://agentmods.dev/rules/jim-schilling/splurge-ai-rules/documentation-standards"><img src="https://agentmods.dev/badge/rules/jim-schilling/splurge-ai-rules/documentation-standards.svg" alt="Measured on agentmods" height="20"></a>
Per session 5 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 148 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.1 $0.00005 $0.00148
Opus 5 $0.00003 $0.00074
Sonnet 5 $0.00001 $0.00030
Haiku 4.5 $0.00001 $0.00015

Measured 6d ago against content hash bbd07eae5078, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

documentation-standards 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 6d 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/documentation-standards.mdc · 23 lines

What it actually says

  • Add comments before complex logic blocks to explain the "why" and "what".
  • Use inline comments sparingly, only for complex or non-obvious code sections.
  • Remove outdated comments during refactoring instead of accumulating them.
  • Use Google-style docstrings for all public functions, classes, and modules in Python:
    def process_data(input_file: str) -> dict:
        """Process input file and return structured data.
    
        Args:
            input_file: Path to the input file to process
    
        Returns:
            Dictionary containing processed data
    
        Raises:
            FileNotFoundError: If input file doesn't exist
        """
    
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. 6d ago First seen · 23 lines · 5 tokens per session scan A bbd07eae5078

Subscribe to this mod's changes

documentation-standards is a cursor rule published in the GitHub repository jim-schilling/splurge-ai-rules (3 stars, last pushed 11mo ago), licensed MIT. It adds 5 tokens to every session and 148 once invoked, about $0.0000 per session on Opus 5. 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-31.