Skip to content

Commit

Permalink
fix long_help
Browse files Browse the repository at this point in the history
  • Loading branch information
BrettMayson committed Nov 9, 2024
1 parent 052ce69 commit ee5830d
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 13 deletions.
5 changes: 2 additions & 3 deletions bin/src/commands/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ use crate::{
use super::global_modules;

#[derive(clap::Parser)]
#[command(
long_about = "Build your project in release mode for testing, without signing for full release."
)]
/// Build the project for final testing
///
/// Build your project in release mode for testing, without signing for full release.
pub struct Command {
#[clap(flatten)]
build: Args,
Expand Down
12 changes: 3 additions & 9 deletions bin/src/commands/dev.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,11 @@ use crate::{

use super::JustArgs;

// #[must_use]
// pub fn cli() -> Command {
// add_just(add_args(
// Command::new("dev")
// .about("Build the project for development")
// .long_about("Build your project for local development and testing. It is built without binarization of .p3d and .rtm files."),
// ))
// }

#[derive(clap::Parser)]
/// Build the project for development
///
/// Build your project for local development and testing.
/// It is built without binarization of .p3d and .rtm files.
pub struct Command {
#[clap(flatten)]
dev: Args,
Expand Down
3 changes: 3 additions & 0 deletions bin/src/commands/launch/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ use crate::{

#[derive(clap::Parser)]
/// Test your project
///
/// Builds your project in dev mode and launches Arma 3 with
/// file patching enabled, loading your mod and any workshop mods.
pub struct Command {
#[clap(flatten)]
launch: Args,
Expand Down
3 changes: 2 additions & 1 deletion bin/src/commands/release.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ use crate::{context::Context, error::Error, modules::Sign, report::Report};
use super::build;

#[derive(clap::Parser)]
#[command(long_about = "Build your project for full release, with signing and archiving.")]
/// Build the project for release
///
/// Build your project for full release, with signing and archiving.
pub struct Command {
#[clap(flatten)]
build: build::Args,
Expand Down
3 changes: 3 additions & 0 deletions bin/src/commands/script.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ use crate::{context::Context, error::Error, modules::Hooks, report::Report};
#[derive(clap::Parser)]
#[command(arg_required_else_help = true)]
/// Run a Rhai script on the project
///
/// Run a Rhai script on the project, this is useful for automating tasks
/// in a platform agnostic way, or requiring external dependencies.
pub struct Command {
#[clap(name = "name")]
name: String,
Expand Down
2 changes: 2 additions & 0 deletions bin/src/commands/value.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ use crate::{context::Context, error::Error, report::Report};
#[derive(clap::Parser)]
#[command(arg_required_else_help = true)]
/// Print a value from the project
///
/// Print a value from the project, use `list` to see all available values
pub struct Command {
#[clap(name = "name")]
name: String,
Expand Down
2 changes: 2 additions & 0 deletions bin/src/utils/verify.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ use crate::{
#[derive(clap::Parser)]
#[command(arg_required_else_help = true)]
/// Verify a signed PBO
///
/// Checks a .bisign file against a public key and PBO
pub struct Command {
/// PBO to verify
pbo: String,
Expand Down

0 comments on commit ee5830d

Please sign in to comment.