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

second-person

A rule that is off by default: it reports we, us, our or ours in a guide, which speaks to the reader as you once a decisions table turns it on.

What it catches

We, us, our or ours in a guide, which speaks to the reader as you.

Dimension

conventions: a house or genre convention is broken. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

A guide is followed step by step by the person reading it; "we" blurs who acts. A "we" the tense rule already reports is left to it, so one word gives one finding. Measured 2026-10-11 over the adjudicated labeling round 2: 18.9% precision (7 of 37) before, 25.0% (7 of 28) after. A heading, a link's text, and a sentence that names the reader beside the project ("you keep the wiring, and we do not force it") or speaks as "I" are left alone. The rest came from READMEs, essays and design pages judged as guides, where "we" names the authors; no guide in this repository fired, and 13 such cases were retired from its labeled set. A guide may say "Let's", taking the reader along as a tutorial does, and "we" may state what the project offers or advises ("we support", "we do not recommend"); a "we" doing a step ("Now we run the build") is still reported. It stays off until a fresh labeling round measures it.

Default decision

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

Kind Default
guide off

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": {"second-person": "deny"},
  "paths": {"blog/**": {"second-person": "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": "second-person", "code": "PRF1003", "decision": "off", "url": "https://eli.gladman.cc/magus/reference/proofread/second-person/"}

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

See also

proofreadrulessecond-personoff
Last updated (29d8b3de)
Earlier changes on this page (1)

Full history ↗ · Blame source ↗

Glossary

Project

A directory magus recognizes as a unit of work (it has a magusfile); the unit of caching, scheduling, and dependency tracking. Project 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.

Conventions

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