fix: sync generated hive-forge CLI docs with their clap source strings
Same bug as the swarmctl/hivectl fix, a third instance argus's review didn't name but nix/checks.nix's hive-forge-docs freshness check (same pattern as hivectl-docs/swarmctl-docs) caught in CI: the earlier Contractions/Foreign/Auto batches edited docs/tools/forge-cli.md directly instead of the clap #[arg(...)]/doc-comment strings in hive-forge/src/main.rs and hive-forge/src/verbs/*.rs. Applied the same 13 wording changes to source that the earlier commits already made to the generated .md, matched 1:1 against 'git diff origin/main HEAD -- docs/tools/forge-cli.md' rather than guessed. Several source doc comments feed two rendered sections each (e.g. reaction.rs's one Add-variant doc renders under both 'issue reaction add' and 'pr reaction add', since both subcommands share the same enum) -- one source fix, two generated-doc fixes. Regenerated from the now-fixed source and confirmed byte-identical to what's already committed (diff exit 0) -- source and generated output are back in sync, same as the swarmctl/hivectl fix. cargo clippy -p hive-forge --all-targets -- -D warnings and scripts/check-doc-refs.sh both clean.
This commit is contained in:
parent
bc8f1b3cb8
commit
17554ea563
11 changed files with 13 additions and 13 deletions
|
|
@ -124,7 +124,7 @@ enum Verb {
|
|||
#[command(hide = true)]
|
||||
PrStatus(verbs::pr_status::Args),
|
||||
/// Clone a forge repo (default `-r`/`HIVE_FORGE_REPO`) with
|
||||
/// credentials auto-injected. Pairs with `pr-create --agit`.
|
||||
/// credentials autoinjected. Pairs with `pr-create --agit`.
|
||||
Clone(verbs::clone::Args),
|
||||
/// Create a forge repo under the current user (or `--org`). Prints
|
||||
/// the repo URL.
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ use crate::client::Client;
|
|||
|
||||
#[derive(ClapArgs)]
|
||||
pub struct Args {
|
||||
/// Artifact name, as shown on the run page (e.g. `pr1ma-paper-pdf`).
|
||||
/// Artifact name, as shown on the run page (for example `pr1ma-paper-pdf`).
|
||||
name: String,
|
||||
/// Workflow run number — the `runs/<n>` in the run-page URL, which
|
||||
/// `pr-status` surfaces as a CI context's `target_url`. (This is the
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ pub struct Args {
|
|||
/// URL (`http://localhost:3000/attachments/abc-123-...`).
|
||||
attachment: String,
|
||||
/// Output path. Defaults to `/tmp/forge-attachment-<uuid>`.
|
||||
/// Pass `-` to write raw bytes to stdout (e.g. for piping to an
|
||||
/// Pass `-` to write raw bytes to stdout (for example for piping to an
|
||||
/// image viewer).
|
||||
#[arg(short = 'o', long)]
|
||||
output: Option<String>,
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ use crate::verbs::print_json;
|
|||
|
||||
#[derive(ClapArgs)]
|
||||
pub struct Args {
|
||||
/// Only runs of this workflow file (e.g. `ci.yml`).
|
||||
/// 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
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ use crate::client::Client;
|
|||
#[derive(ClapArgs)]
|
||||
pub struct Args {
|
||||
/// Destination directory. Defaults to the repo's basename
|
||||
/// (e.g. `internal/knowledge` → `knowledge`).
|
||||
/// (for example `internal/knowledge` → `knowledge`).
|
||||
dest: Option<String>,
|
||||
/// Branch to check out after cloning.
|
||||
#[arg(long)]
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ pub struct Args {
|
|||
/// Initial assignee login.
|
||||
#[arg(long)]
|
||||
assignee: Option<String>,
|
||||
/// Label name to attach, repeatable (e.g. `--label area/ops --label
|
||||
/// Label name to attach, repeatable (for example `--label area/ops --label
|
||||
/// type/bug`). Same spelling `labels add` accepts. An unresolved name
|
||||
/// errors out (before the issue is created) rather than silently
|
||||
/// attaching fewer labels than asked for.
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ enum Sub {
|
|||
/// Group open issues + PRs by assignee.
|
||||
Assignments(AssignmentsArgs),
|
||||
/// List issues/PRs with no exclusive scoped label in `--scope`
|
||||
/// (e.g. `--scope type` flags items missing any `type/*` label).
|
||||
/// (for example `--scope type` flags items missing any `type/*` label).
|
||||
/// Generic — the scope is whatever the repo's label taxonomy
|
||||
/// actually uses, nothing hardcoded here.
|
||||
Unlabeled(UnlabeledArgs),
|
||||
|
|
@ -139,7 +139,7 @@ struct AssignmentsArgs {
|
|||
#[derive(ClapArgs)]
|
||||
struct UnlabeledArgs {
|
||||
/// Label scope to check for — the part of a scoped label's name
|
||||
/// before the `/` (e.g. `type` for `type/bug`, `type/feature`).
|
||||
/// before the `/` (for example `type` for `type/bug`, `type/feature`).
|
||||
/// Required: this command has no built-in notion of a repo's label
|
||||
/// taxonomy, so there's no sane default to fall back to.
|
||||
#[arg(long)]
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ pub struct Args {
|
|||
/// meaningful with `--agit`.
|
||||
#[arg(long)]
|
||||
topic: Option<String>,
|
||||
/// Label name to attach, repeatable (e.g. `--label area/ops --label
|
||||
/// 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
|
||||
|
|
|
|||
|
|
@ -53,13 +53,13 @@ impl Method {
|
|||
pub struct Args {
|
||||
/// PR number to merge.
|
||||
number: u64,
|
||||
/// Merge strategy (default: a merge commit). Squash is not offered.
|
||||
/// Merge strategy (default: a merge commit). Squash isn't offered.
|
||||
#[arg(long, value_enum, default_value = "merge")]
|
||||
method: Method,
|
||||
/// Keep the head branch after merging (deleted by default).
|
||||
#[arg(long = "keep-branch")]
|
||||
keep_branch: bool,
|
||||
/// Merge even if the PR is not mergeable, CI is not green, or a review
|
||||
/// Merge even if the PR isn't mergeable, CI isn't green, or a review
|
||||
/// requests changes.
|
||||
#[arg(long)]
|
||||
force: bool,
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ pub struct Args {
|
|||
enum Action {
|
||||
/// List reactions (default when no action is given).
|
||||
List,
|
||||
/// Add a reaction — a Forgejo shortcode, e.g. `+1`, `heart`, `rocket`.
|
||||
/// Add a reaction — a Forgejo shortcode, for example `+1`, `heart`, `rocket`.
|
||||
Add { content: String },
|
||||
/// Remove your own reaction with this content.
|
||||
Remove { content: String },
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ pub struct Args {
|
|||
/// Create the repo as private (default: public).
|
||||
#[arg(long)]
|
||||
private: bool,
|
||||
/// Default branch name (e.g. `main`). Only takes effect with `--auto-init`.
|
||||
/// Default branch name (for example `main`). Only takes effect with `--auto-init`.
|
||||
#[arg(long = "default-branch")]
|
||||
default_branch: Option<String>,
|
||||
/// Create under this organisation instead of your own namespace.
|
||||
|
|
|
|||
Loading…
Reference in a new issue