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

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

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

23
hive-forge/src/verbs/pr_create.rs
View file

@ -48,29 +48,22 @@ pub struct Args {
/// Read body from a file. `-` means stdin.
#[arg(long = "body-file")]
body_file: Option<String>,
/// Open as draft. Ignored in `--agit` mode (the `AGit` push has no
/// draft push-option).
/// Open as draft. Ignored in `--agit` mode.
#[arg(long)]
draft: bool,
/// Push the local `--head` branch to `--remote` before creating
/// the PR. Suppresses forgejo's "Create / Visit a pull request"
/// hint block (we print the URL ourselves).
/// Push the local `--head` branch to `--remote` before creating the PR.
#[arg(long)]
push: bool,
/// Remote name to push to. Defaults to the hyperhive convention
/// `forge` for the normal flow, and `origin` in `--agit` mode (the
/// remote a `hive-forge clone` sets up).
/// Remote to push to (default: `forge`, or `origin` in `--agit` mode).
#[arg(long)]
remote: Option<String>,
/// Open the PR via Forgejo's `AGit` flow: push the current `HEAD`
/// to `refs/for/<base>/<topic>` instead of calling the REST API.
/// Works for read-only collaborators (no branch-push needed). Run
/// from inside a cloned repo.
/// Open the PR via Forgejo's `AGit` flow instead of pushing a branch —
/// works for read-only collaborators. Run from inside a cloned repo.
#[arg(long)]
agit: bool,
/// `AGit` topic — groups repeated pushes into ONE PR (re-running
/// with the same topic updates it). Defaults to the current branch
/// name, or `contribution`. Only meaningful with `--agit`.
/// `AGit` topic — groups repeated pushes into one PR (re-run with the
/// same topic to update it). Defaults to the branch name. Only
/// meaningful with `--agit`.
#[arg(long)]
topic: Option<String>,
}