Watch
0
0
Fork
You've already forked hyperhive
0

rewrite generated CLI docs' passive voice to active

hive-forge and hivectl doc-comment strings for pr-create --label, diff
--full, list --label, ci-runs --branch, and several hivectl subcommand
options read as if things happened to themselves. Name the actor (hivectl,
hive-forge, or the CLI) instead, and regenerate the three docs/tools/*-cli.md
files from the rebuilt binaries.

swarmctl-cli.md needs no source change: its only passive hit is
clap-markdown's own generated boilerplate, out of scope here.
This commit is contained in:
iris 2026-09-08 14:46:52 +02:00 • committed by mara
commit 7396903994
7 changed files with 39 additions and 39 deletions

View file

@ -21,9 +21,9 @@ pub struct Args {
/// Only runs of this workflow file (for example `ci.yml`).
#[arg(long)]
workflow: Option<String>,
/// Only runs on this ref. A branch name (`main`, `damocles/foo`) or a
/// PR (`#N`) is qualified for you; a `refs/…` value is used as
/// given. An all-digit value is read as a PR number — to filter a
/// Only runs on this ref. hive-forge qualifies a branch name (`main`,
/// `damocles/foo`) or a PR (`#N`) for you, uses a `refs/…` value as
/// given, and reads an all-digit value as a PR number — to filter a
/// branch literally named that, pass `refs/heads/<name>`.
#[arg(long)]
branch: Option<String>,