summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCyborus <cyborus@cyborus.xyz>2024-08-04 17:12:49 +0200
committerCyborus <cyborus@cyborus.xyz>2024-08-04 17:12:49 +0200
commitca6d0d821d1c851bb253778b437cca2ed61509e9 (patch)
tree706f0c3be229023c2a5646bb2398a0e92e17e2b3
parentdocs: document commands (diff)
downloadforgejo-cli-ca6d0d821d1c851bb253778b437cca2ed61509e9.tar.xz
forgejo-cli-ca6d0d821d1c851bb253778b437cca2ed61509e9.zip
docs: document `--remote`
-rw-r--r--src/issues.rs1
-rw-r--r--src/prs.rs2
-rw-r--r--src/release.rs2
-rw-r--r--src/user.rs1
4 files changed, 5 insertions, 1 deletions
diff --git a/src/issues.rs b/src/issues.rs
index 5889e59..a65e3d4 100644
--- a/src/issues.rs
+++ b/src/issues.rs
@@ -11,6 +11,7 @@ use crate::repo::{RepoArg, RepoInfo, RepoName};
#[derive(Args, Clone, Debug)]
pub struct IssueCommand {
+ /// The local git remote that points to the repo to operate on.
#[clap(long, short = 'R')]
remote: Option<String>,
#[clap(subcommand)]
diff --git a/src/prs.rs b/src/prs.rs
index c8f7389..840ae12 100644
--- a/src/prs.rs
+++ b/src/prs.rs
@@ -18,7 +18,7 @@ use crate::{
#[derive(Args, Clone, Debug)]
pub struct PrCommand {
- /// The git remote to operate on.
+ /// The local git remote that points to the repo to operate on.
#[clap(long, short = 'R')]
remote: Option<String>,
#[clap(subcommand)]
diff --git a/src/release.rs b/src/release.rs
index f0069ee..fa9d7d7 100644
--- a/src/release.rs
+++ b/src/release.rs
@@ -14,8 +14,10 @@ use crate::{
#[derive(Args, Clone, Debug)]
pub struct ReleaseCommand {
+ /// The local git remote that points to the repo to operate on.
#[clap(long, short = 'R')]
remote: Option<String>,
+ /// The name of the repository to operate on.
#[clap(long, short, id = "[HOST/]OWNER/REPO")]
repo: Option<RepoArg>,
#[clap(subcommand)]
diff --git a/src/user.rs b/src/user.rs
index 8f8b4e9..d38d8b5 100644
--- a/src/user.rs
+++ b/src/user.rs
@@ -6,6 +6,7 @@ use crate::{repo::RepoInfo, SpecialRender};
#[derive(Args, Clone, Debug)]
pub struct UserCommand {
+ /// The local git remote that points to the repo to operate on.
#[clap(long, short = 'R')]
remote: Option<String>,
#[clap(subcommand)]