Docs Checker

Documentation Grammar & Style Checker

Check documentation files for grammar, punctuation, and style errors. Minimize changes: only fix actual errors. Do not rewrite or restructure text, do not add content, do not remove blocks of text.

Selecting files to check

• With arguments ($ARGUMENTS): check only the specified files or glob patterns.
• Without arguments: check .rst and .py files changed on the current branch vs main. Run:

  git diff main...HEAD --name-only -- '*.rst' '*.py'
  

  If there are no changes vs main (e.g., on main itself), ask the user which files to check.

What to check

Only check prose text: skip code blocks, directive parameters, RST markup syntax, and inline code literals. For .py files, only check docstrings (triple-quoted strings), not comments or code.

1. Contractions (expand to full words)

Find and expand all contractions. Common ones:

2. Common misspellings

3. Incorrect idioms and phrases

4. Passive voice → active voice

Convert passive to active where it reads more naturally. Use appropriate subjects:

• Kopf when referring to the framework itself
• the operator when referring to operators built with Kopf
• the handler when referring to handler functions
• the user or you when referring to the developer using Kopf

Examples:

• "It is used for ..." → "Kopf uses it for ..."
• "The state is stored in ..." → "Kopf stores the state in ..."
• "Multiple namespaces can be served" → "The operator can serve multiple namespaces"

Do not force active voice when passive reads more naturally or when the actor is genuinely unknown.

5. Articles and agreement

• Check for missing articles (a, an, the) before singular countable nouns
• Check subject-verb agreement ("the handler run" → "the handler runs")
• Check pronoun agreement ("Handlers ... its" → "Handlers ... their")

6. Em dashes

Use --- (triple-minus) for em dashes in RST files. Replace any unicode em dash (—, U+2014) or double-minus (--) used as an em dash with ---.

7. RST-specific issues

• Markdown-style links in .rst files: [text](url) should be `text <url>`_
• Incorrect capitalization of abbreviations: "RsT" → "RST", "yaml" → "YAML", "json" → "JSON"

8. American English consistency

Use American English spelling when the file already uses it:

Process

1. Determine which files to check (from arguments or git diff).
2. Read each file fully.
3. Scan prose text (skip code blocks and RST directives) for issues from the checklist above.
4. For each issue found, apply a fix using the Edit tool.
5. After fixing all files, report a summary of changes made per file.

Important rules

• Minimize changes. Only fix actual errors. Do not improve wording that is already correct.
• Do not touch code blocks, inline code, directive parameters, or RST/Markdown structural markup.
• Do not remove or restructure text. Keep the original meaning and structure intact.
• Do not add content such as new paragraphs, comments, docstrings, or annotations.
• Preserve the author's voice. Only fix what is objectively wrong or inconsistent.

Source: nolar/kopf — distributed by TomeVault.