From 5dd14266f2609faadc3ec60077127a7ef7e8ac8b Mon Sep 17 00:00:00 2001 From: Lukasz Kasprzak Date: Wed, 2 Sep 2026 12:30:56 +0200 Subject: feat(cli): --help is one screen, not the whole manual It printed 374 lines: every output format, the RFC 4180 quoting rule, the template scope hazard, the publish manifest semantics. All of that is real documentation and all of it is already in colitur(1), installed beside the binary. A help text nobody reads at the terminal is not more helpful than a short one, it is less -- the reader stops looking. Now 42 lines: the commands, the flags most runs need, the year domain, the exit status, and where the rest lives. Everything removed is in the man pages, which is checked rather than assumed -- each dropped section has a counterpart section there. One thing moved rather than went. cli.t pinned `rubrics`' documented field list against what `rubrics` actually prints, because that field count drifted once already and stayed wrong for a whole review round. Deleting the prose would have quietly retired the check, so it now reads the worked example out of man/colitur.1 instead, and test/dune's cram stanza gains the man page as a dep -- a sandbox holds only what that stanza names. Mutation-tested: changing the documented example reddens the suite. The tagline also stopped saying "Roman rite, 1962" -- the OF has shipped since v1.1.0. --- man/colitur.1 | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'man/colitur.1') diff --git a/man/colitur.1 b/man/colitur.1 index 4d639f8..8a00a88 100644 --- a/man/colitur.1 +++ b/man/colitur.1 @@ -81,6 +81,10 @@ colitur \- deterministic liturgical calendar and lectionary engine (Roman rite, .B colitur .BR \-h | \-\-help .SH DESCRIPTION +.\" --help was trimmed to one screen (2026-08-28); this page is now the only +.\" place the formats, file syntaxes and hazards are written down, which is +.\" what that help text tells the reader. + .B colitur computes the liturgical calendar of the 1962 Roman Missal \(em the Extraordinary Form \(em and the Mass reading citations for every day, entirely -- cgit v1.3