From 4bcf104c8048af559aa7f119a6d7826ba046a4a0 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Fri, 12 Sep 2025 09:43:37 +0000 Subject: [PATCH] docs: update commands titles and descriptions Signed-off-by: Awiteb --- CHANGELOG.md | 1 + docs/SUMMARY.md | 26 +++++++++++++------------- docs/issue/close.md | 2 +- docs/issue/list.md | 2 +- docs/issue/reopen.md | 2 +- docs/issue/resolve.md | 2 +- docs/issue/view.md | 2 +- docs/patch/apply.md | 2 +- docs/patch/close.md | 2 +- docs/patch/draft.md | 2 +- docs/patch/fetch.md | 2 +- docs/patch/list.md | 2 +- docs/patch/merge.md | 2 +- docs/patch/reopen.md | 2 +- docs/pr/merge.md | 2 +- src/cli/commands/issue/mod.rs | 12 ++++++------ src/cli/commands/patch/mod.rs | 16 ++++++++-------- 17 files changed, 41 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b8d0f9..08c2366 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Documentation - Update commands help messages - by Awiteb +- Update commands titles and descriptions - by Awiteb ### Fixed diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 523c09b..12af4e8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -19,20 +19,20 @@ - [Reply to Issues and Patches](reply.md) - [Issue Management](issue/README.md) - [Create an Issue](issue/new.md) - - [View an Issue By ID](issue/view.md) - - [Reopen a Closed Issue](issue/reopen.md) - - [Closes an Open Issue](issue/close.md) - - [Resolves an Issue](issue/resolve.md) - - [List Repositories Issues](issue/list.md) + - [View an Issue](issue/view.md) + - [Reopen an Issue](issue/reopen.md) + - [Close an Issue](issue/close.md) + - [Resolve an Issue](issue/resolve.md) + - [List Issues](issue/list.md) - [Patch Management](patch/README.md) - [Send Patches to a Repository](patch/send.md) - - [Fetch a Patch By ID](patch/fetch.md) - - [Reopens a Closed or Drafted Patch](patch/reopen.md) - - [Closes an Open or Drafted Patch](patch/close.md) - - [Draft an Open Patch](patch/draft.md) - - [Apply an Open Patch](patch/apply.md) - - [Merge an Open Patch](patch/merge.md) - - [List Repositories Patches](patch/list.md) + - [Fetch a Patch](patch/fetch.md) + - [Close a Patch](patch/close.md) + - [Convert to Draft](patch/draft.md) + - [Reopen a Patch](patch/reopen.md) + - [Mark as Applied](patch/apply.md) + - [Mark as Merged](patch/merge.md) + - [List Patches](patch/list.md) - [Pull Request Management](pr/README.md) - [Create a Pull Request](pr/new.md) - [Update a Pull Request](pr/update.md) @@ -42,4 +42,4 @@ - [Convert to Draft](pr/draft.md) - [Reopen a Pull Request](pr/reopen.md) - [Mark as Applied](pr/apply.md) - - [Merge a Pull Request](pr/merge.md) + - [Mark as Merged](pr/merge.md) diff --git a/docs/issue/close.md b/docs/issue/close.md index 93efeda..9fd323d 100644 --- a/docs/issue/close.md +++ b/docs/issue/close.md @@ -1,4 +1,4 @@ -# Closes an Open Issue +# Close an Issue > `n34 issue close` command diff --git a/docs/issue/list.md b/docs/issue/list.md index 1c01730..4265ef1 100644 --- a/docs/issue/list.md +++ b/docs/issue/list.md @@ -1,4 +1,4 @@ -# List Repositories Issues +# List Issues > `n34 issue list` command diff --git a/docs/issue/reopen.md b/docs/issue/reopen.md index c2747e4..f98015a 100644 --- a/docs/issue/reopen.md +++ b/docs/issue/reopen.md @@ -1,4 +1,4 @@ -# Reopen a Closed Issue +# Reopen an Issue > `n34 issue reopen` command diff --git a/docs/issue/resolve.md b/docs/issue/resolve.md index 3cd1045..a9178d2 100644 --- a/docs/issue/resolve.md +++ b/docs/issue/resolve.md @@ -1,4 +1,4 @@ -# Resolves an Issue +# Resolve an Issue > `n34 issue resolve` command diff --git a/docs/issue/view.md b/docs/issue/view.md index 0200277..547a5b3 100644 --- a/docs/issue/view.md +++ b/docs/issue/view.md @@ -1,4 +1,4 @@ -# View an Issue By ID +# View an Issue > `n34 issue view` command diff --git a/docs/patch/apply.md b/docs/patch/apply.md index d594583..af10402 100644 --- a/docs/patch/apply.md +++ b/docs/patch/apply.md @@ -1,4 +1,4 @@ -# Apply an Open Patch +# Mark as Applied > `n34 patch apply` command diff --git a/docs/patch/close.md b/docs/patch/close.md index fd0ef13..cc36f2b 100644 --- a/docs/patch/close.md +++ b/docs/patch/close.md @@ -1,4 +1,4 @@ -# Closes an Open or Drafted Patch +# Close a Patch > `n34 patch close` command diff --git a/docs/patch/draft.md b/docs/patch/draft.md index 7c1d174..e1ca398 100644 --- a/docs/patch/draft.md +++ b/docs/patch/draft.md @@ -1,4 +1,4 @@ -# Draft an Open Patch +# Convert to Draft > `n34 patch draft` command diff --git a/docs/patch/fetch.md b/docs/patch/fetch.md index d15f019..467a455 100644 --- a/docs/patch/fetch.md +++ b/docs/patch/fetch.md @@ -1,4 +1,4 @@ -# Fetch a Patch By ID +# Fetch a Patch > `n34 patch fetch` command diff --git a/docs/patch/list.md b/docs/patch/list.md index c745bd1..75538fa 100644 --- a/docs/patch/list.md +++ b/docs/patch/list.md @@ -1,4 +1,4 @@ -# List Repositories Patches +# List Patches > `n34 patch list` command diff --git a/docs/patch/merge.md b/docs/patch/merge.md index ec766bf..ba3ce30 100644 --- a/docs/patch/merge.md +++ b/docs/patch/merge.md @@ -1,4 +1,4 @@ -# Merge an Open Patch +# Mark as Merged > `n34 patch merge` command diff --git a/docs/patch/reopen.md b/docs/patch/reopen.md index cc24b10..0beba3d 100644 --- a/docs/patch/reopen.md +++ b/docs/patch/reopen.md @@ -1,4 +1,4 @@ -# Reopens a Closed or Drafted Patch +# Reopen a Patch > `n34 patch reopen` command diff --git a/docs/pr/merge.md b/docs/pr/merge.md index e7d81cf..92c7bb6 100644 --- a/docs/pr/merge.md +++ b/docs/pr/merge.md @@ -1,4 +1,4 @@ -# Merge a Pull Request +# Mark as Merged > `n34 pr merge` command diff --git a/src/cli/commands/issue/mod.rs b/src/cli/commands/issue/mod.rs index 85dea65..73d105a 100644 --- a/src/cli/commands/issue/mod.rs +++ b/src/cli/commands/issue/mod.rs @@ -46,17 +46,17 @@ pub const ISSUE_ALT_PREFIX: &str = "git issue: "; #[derive(Subcommand, Debug)] pub enum IssueSubcommands { - /// Create a new repository issue + /// Create an issue New(NewArgs), - /// View an issue by its ID + /// View an issue View(ViewArgs), - /// Reopens a closed issue. + /// Reopen an issue. Reopen(ReopenArgs), - /// Closes an open issue. + /// Closes an issue. Close(CloseArgs), - /// Resolves an issue. + /// Resolve an issue. Resolve(ResolveArgs), - /// List the repositories issues. + /// List issues. List(ListArgs), } diff --git a/src/cli/commands/patch/mod.rs b/src/cli/commands/patch/mod.rs index b90c6a6..87aaea7 100644 --- a/src/cli/commands/patch/mod.rs +++ b/src/cli/commands/patch/mod.rs @@ -79,21 +79,21 @@ pub const LEGACY_NGIT_REVISION_ROOT_HASHTAG_CONTENT: &str = "revision-root"; #[derive(Subcommand, Debug)] pub enum PatchSubcommands { - /// Send one or more patches to a repository. + /// Send patches to a repository Send(SendArgs), - /// Fetches a patch by its id. + /// Fetch a patch Fetch(FetchArgs), - /// Closes an open or drafted patch. + /// Close a patch Close(CloseArgs), - /// Converts an open patch to draft state. + /// Convert to draft Draft(DraftArgs), - /// Reopens a closed or drafted patch. + /// Reopen a patch Reopen(ReopenArgs), - /// Set an open patch status to applied. + /// Mark as applied Apply(ApplyArgs), - /// Set an open patch status to merged. + /// Mark as merged Merge(MergeArgs), - /// List the repositories patches. + /// List patches List(ListArgs), }