magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
2 min read

all-caps

An advisory by default: it explains, and blocks nothing, on words in capitals for emphasis in a review reply ("DO NOT", "NEVER").

What it catches

Words in capitals for emphasis in a review reply ("DO NOT", "NEVER").

Dimension

stance: the text reads as a verdict on a person, or as addressed to someone else. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

Capitals read as shouting. An acronym is left alone: the rule reports a run of capital words only when it holds an English word such as NOT, NEVER or ALL. Measured 2026-10-10 over the AIDev review comments: 0.41 percent of 39639 written by people and 0.37 percent of 42076 written by bots, which capitalize ALL and ANY in technical prose too, so the rule does not tell the two apart and only advises. Measured 2026-10-11 over the adjudicated labeling round: 65.9% precision (27 of 41) before, 90.0% (27 of 30, lower bound 0.74) after, so it ships advise. AND or OR joining a condition is an operator, and capitals in single quotes, "ALL CAPS" and one capital word opening a name ("IT Admin") are left alone.

Default decision

The code is PRF8013. The decision depends on the kind of text judged:

Kind Default
review-summary advise
review-inline advise
review-reply advise

Changing it

A decisions table sets this rule to deny, advise or off, for everything judged or for the files a glob matches. Proofread reads the table from the file its -decisions flag names:

{
  "rules": {"all-caps": "deny"},
  "paths": {"blog/**": {"all-caps": "off"}}
}

rules applies to every file. A glob in paths applies to the files it matches, and the last match wins. A rule set to off never reports.

Seeing it

A finding names the rule, its code and the decision that applies, and links here:

{"rule": "all-caps", "code": "PRF8013", "decision": "advise", "url": "https://eli.gladman.cc/magus/reference/proofread/all-caps/"}

proofread rules prints this entry with every other rule's.

See also

ReferencePages in this section. nominalizationsAn advisory by default: it explains, and blocks nothing, on a text whose verbs are turned into nouns (validation, agreement, stability) at a generated-writing rate. participlesAn advisory by default: it explains, and blocks nothing, on a text that hangs present participial clauses on its sentences at a generated-writing rate. repeated-marksAn advisory by default: it explains, and blocks nothing, on a run of question or exclamation marks in a review reply ("??", "!!", "?!").
proofreadrulesall-capsadvise
Last updated (87041fca)
Earlier changes on this page (2)

Full history ↗ · Blame source ↗

Glossary

Op

A single tool-native command a target composes (long form: operation); the middle of the work hierarchy (Spell to Op to Target). Op in full.

CI

An ordinary target you compose yourself with ctx.needs; magus does not hardcode its stages. It is the anchor magus affected ci keys off, and ci strips the rw charm. CI in full.

Run

One target executing under one magus invocation, such as magus run test web or magus affected ci. A run keeps its captured output behind an output reference. Every magus run is a run whether or not any job asked for it; see Job for how the two relate. Run in full.

Advisor

One read-only check from the advice suite: it reads the changeset through magus and writes one titled section of findings. The same advisors run as a pull request comment in CI and inside magus diff --impact locally. Advisor in full.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.