diff options
| author | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-09-02 12:30:56 +0200 |
|---|---|---|
| committer | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-09-02 12:30:56 +0200 |
| commit | 5dd14266f2609faadc3ec60077127a7ef7e8ac8b (patch) | |
| tree | d083272016976f7f6ed957697110674061c89a17 /test/dune | |
| parent | 4fb9eac2fdb9bc22af2b63c1d5df6da7780b58cf (diff) | |
| download | colitur-5dd14266f2609faadc3ec60077127a7ef7e8ac8b.tar.gz colitur-5dd14266f2609faadc3ec60077127a7ef7e8ac8b.zip | |
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.
Diffstat (limited to 'test/dune')
| -rw-r--r-- | test/dune | 9 |
1 files changed, 8 insertions, 1 deletions
@@ -105,4 +105,11 @@ ../schema/day-v1.json ; Same trap, same fix: Task 8's --sigla-tradition flag makes the CLI read ; this file, and a cram sandbox holds only what this stanza names. - ../lang/traditions.ini)) + ../lang/traditions.ini + ; The man page is a DEP, not a runtime file the binary reads: cli.t's own + ; rubrics anti-drift check compares the documented worked example against + ; what `rubrics` actually prints, and that documentation now lives here + ; rather than in --help (trimmed to one screen). The check exists because + ; this exact field list drifted once and stayed wrong for a whole review + ; round; moving the prose without moving the check would quietly retire it. + ../man/colitur.1)) |