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

verdict

An advisory by default: it explains, and blocks nothing, on a judgment word standing in for the behavior it judges ("was broken", "a mess").

What it catches

A judgment word standing in for the behavior it judges ("was broken", "a mess").

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

A verdict tells the reader what to think in place of what happened. It advises because "broken" and "wrong" also name a broken test or the wrong checkout; it moves to deny only after every firing on real text was right. Measured 2026-10-11 over the adjudicated labeling round: 20.9% precision (9 of 43) before, 100% (9 of 9) after. Most firings named the behavior beside the word, so a verdict with a reason or cause in its sentence, or a later sentence in its paragraph, is left alone, as are quoted words, a broken test or link, a denied or supposed state ("nothing was broken", "may be broken"), and the verb senses ("broken into lines", "mess with"). Labeling round 3 measured 16 of 40, a lower bound of 0.26, which each graded finding weighs.

Default decision

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

Kind Default
change-description advise
review-summary advise
review-inline advise
review-reply advise
commit-message advise
issue 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": {"verdict": "deny"},
  "paths": {"blog/**": {"verdict": "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": "verdict", "code": "PRF2002", "decision": "advise", "url": "https://eli.gladman.cc/magus/reference/proofread/verdict/"}

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

See also

proofreadrulesverdictadvise
Last updated (87041fca)
Earlier changes on this page (2)

Full history ↗ · Blame source ↗

Glossary

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.

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.