docs: update commands titles and descriptions

Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb
2025-09-12 09:43:37 +00:00
parent 4360aa192c
commit 4bcf104c80
17 changed files with 41 additions and 40 deletions

View File

@@ -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

View File

@@ -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)

View File

@@ -1,4 +1,4 @@
# Closes an Open Issue
# Close an Issue
> `n34 issue close` command

View File

@@ -1,4 +1,4 @@
# List Repositories Issues
# List Issues
> `n34 issue list` command

View File

@@ -1,4 +1,4 @@
# Reopen a Closed Issue
# Reopen an Issue
> `n34 issue reopen` command

View File

@@ -1,4 +1,4 @@
# Resolves an Issue
# Resolve an Issue
> `n34 issue resolve` command

View File

@@ -1,4 +1,4 @@
# View an Issue By ID
# View an Issue
> `n34 issue view` command

View File

@@ -1,4 +1,4 @@
# Apply an Open Patch
# Mark as Applied
> `n34 patch apply` command

View File

@@ -1,4 +1,4 @@
# Closes an Open or Drafted Patch
# Close a Patch
> `n34 patch close` command

View File

@@ -1,4 +1,4 @@
# Draft an Open Patch
# Convert to Draft
> `n34 patch draft` command

View File

@@ -1,4 +1,4 @@
# Fetch a Patch By ID
# Fetch a Patch
> `n34 patch fetch` command

View File

@@ -1,4 +1,4 @@
# List Repositories Patches
# List Patches
> `n34 patch list` command

View File

@@ -1,4 +1,4 @@
# Merge an Open Patch
# Mark as Merged
> `n34 patch merge` command

View File

@@ -1,4 +1,4 @@
# Reopens a Closed or Drafted Patch
# Reopen a Patch
> `n34 patch reopen` command

View File

@@ -1,4 +1,4 @@
# Merge a Pull Request
# Mark as Merged
> `n34 pr merge` command

View File

@@ -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),
}

View File

@@ -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),
}