docs(#2671): trim per-verb arg help (pr-create, comments, ci-log, ci-rerun)

Drop implementation detail from the clap arg help (the `<verb> --help`
surface) — which API/endpoint, page-count math, persisted-vs-streamer
log-source internals, refspec shapes — keeping only what/when-to-use for
each flag. Module `//!` docs (dev-facing, not shown by `--help`) left
intact.
This commit is contained in:
atlas 2026-07-23 21:55:04 +02:00
commit ef9935e3d0
4 changed files with 24 additions and 39 deletions

View file

@ -30,20 +30,17 @@ use crate::client::Client;
#[derive(ClapArgs)]
pub struct Args {
/// Workflow run number — the `runs/<n>` in the run-page URL, which
/// `pr-status` surfaces as a CI context's `target_url`.
/// Workflow run number — the `runs/<n>` in the run-page URL (shown
/// by `pr-status`).
#[arg(long)]
run: u64,
/// Job index within the run (0-based; default 0 — the first job).
/// Job index within the run (0-based, default 0).
#[arg(long, default_value_t = 0)]
job: u64,
/// Print only this step's log (0-based). Omit to print every step.
/// Honored on the live-streamer path only; the durable persisted-log
/// fallback serves a flat whole-job log and ignores `--step`.
#[arg(long)]
step: Option<usize>,
/// Run attempt number for the durable persisted-log download (re-runs
/// increment it; default 1 covers the common single-attempt case).
/// Run attempt number (re-runs increment it; default 1).
#[arg(long, default_value_t = 1)]
attempt: u64,
}