vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

hive-forge, hivectl, swarmctl: fix clap help passive voice, regen docs

Browse source 
Rewrites every write-good.Passive hit in the hive-forge clap help text
into terse, imperative, active voice (meaning unchanged) and drops
clap-markdown's own fixed footer ('This document was generated
automatically by...') via MarkdownOptions::show_footer(false), since
that string isn't ours to reword and vale flagged it too.

docs/tools/{hivectl,swarmctl,forge}-cli.md are generated from each
crate's clap tree (see hive-forge/src/main.rs's MarkdownDocs verb) —
regenerated here from the fixed source, not hand-edited.

Refs #4549
This commit is contained in:
atlas 2026-09-20 05:38:30 +02:00 • committed by mara
commit f0e3ed04d3
18 changed files with 87 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

9
hive-forge/src/main.rs
View file

@ -226,7 +226,14 @@ fn run() -> Result<()> {
// credentials — just a pure render of the clap tree the docs build
// pipes into `docs/tools/forge-cli.md`.
if let Verb::MarkdownDocs = verb {
print!("{}", clap_markdown::help_markdown::<Cli>());
// `show_footer(false)`: the default footer's wording ("This
// document was generated automatically by...") is clap-markdown's
// own fixed text, not ours to reword into active voice, and the
// repo's docs are prose we write ourselves throughout — so we
// drop the footer rather than carry the one string in this tree
// we have no control over.
let options = clap_markdown::MarkdownOptions::new().show_footer(false);
print!("{}", clap_markdown::help_markdown_custom::<Cli>(&options));
return Ok(());
}
let client = client::Client::from_env(cli.repo, cli.json, cli.forge)