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:
parent
97e2a993e3
commit
7396903994
7 changed files with 39 additions and 39 deletions
|
|
@ -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>,
|
||||
|
|
|
|||
|
|
@ -23,9 +23,9 @@ use crate::client::{Client, index};
|
|||
pub struct Args {
|
||||
/// PR number.
|
||||
number: u64,
|
||||
/// Print the unfiltered diff. By default, autogenerated-file hunks
|
||||
/// (`flake.lock`, `Cargo.lock`, …) are collapsed to a placeholder so
|
||||
/// human-authored changes stay readable.
|
||||
/// Print the unfiltered diff. By default, hive-forge collapses
|
||||
/// autogenerated-file hunks (`flake.lock`, `Cargo.lock`, …) to a
|
||||
/// placeholder so human-authored changes stay readable.
|
||||
#[arg(long)]
|
||||
full: bool,
|
||||
}
|
||||
|
|
|
|||
|
|
@ -97,8 +97,8 @@ pub struct Args {
|
|||
#[arg(long)]
|
||||
mention: Option<String>,
|
||||
/// Filter to items carrying any of these label names. Repeatable.
|
||||
/// Validated client-side: a name the forge can't resolve is dropped
|
||||
/// from the filter rather than rejected, which returns MORE results
|
||||
/// Validated client-side: the CLI drops a name the forge can't resolve
|
||||
/// from the filter rather than rejecting it, which returns MORE results
|
||||
/// than asked for, not fewer.
|
||||
#[arg(long = "label")]
|
||||
labels: Vec<String>,
|
||||
|
|
|
|||
|
|
@ -71,11 +71,11 @@ pub struct Args {
|
|||
/// Label name to attach, repeatable (for example `--label area/ops --label
|
||||
/// type/bug`). Same spelling `labels add` accepts — an unresolved name
|
||||
/// errors out rather than silently attaching fewer labels than asked
|
||||
/// for. In `--agit` mode this is applied as a follow-up call once the
|
||||
/// PR number is known (the `AGit` push itself has no label field), so
|
||||
/// it's silently skipped (not a label-resolution error) if the PR URL
|
||||
/// couldn't be parsed back out of the push output — same fallback as
|
||||
/// the deferred multi-line body.
|
||||
/// for. In `--agit` mode `pr-create` applies this as a follow-up call
|
||||
/// once it learns the PR number (the `AGit` push itself has no label
|
||||
/// field), so it silently skips them (not a label-resolution error) if
|
||||
/// it couldn't parse the PR URL back out of the push output — same
|
||||
/// fallback as the deferred multi-line body.
|
||||
#[arg(long = "label")]
|
||||
labels: Vec<String>,
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue