From 8b705ed7cfc2e46a896113ad65adcaa7be685d06 Mon Sep 17 00:00:00 2001
From: Louis Capitanchik <contact@louiscap.co>
Date: Tue, 7 Feb 2023 20:59:52 +0000
Subject: [PATCH] Update subcommand descriptions
---
src/cli_args.rs | 2 +-
src/commands/flip.rs | 6 +++---
src/commands/palette.rs | 4 ++--
src/commands/pipeline.rs | 2 +-
src/commands/remap.rs | 6 +++---
src/commands/scale.rs | 6 +++---
6 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/cli_args.rs b/src/cli_args.rs
index ddc5234..1177319 100644
--- a/src/cli_args.rs
+++ b/src/cli_args.rs
@@ -9,7 +9,7 @@ use crate::{load_image, Format};
/// Crunch is a set of utilities for quickly and easily processing a batch of files, either directly
/// or by defining pipelines
#[derive(Parser, Debug, Clone, Serialize, Deserialize)]
-#[clap(name = "Crunch")]
+#[clap(name = "crunch")]
#[clap(author = "Louis Capitanchik <louis@microhacks.co.uk>")]
#[clap(version = "0.5.0-beta.1")]
#[clap(about, long_about = None)]
diff --git a/src/commands/flip.rs b/src/commands/flip.rs
index 787c1d7..19ac073 100644
--- a/src/commands/flip.rs
+++ b/src/commands/flip.rs
@@ -13,14 +13,14 @@ pub enum FlipDirection {
Both,
}
-/// Rotate an image clockwise by the given degree
+/// Flip an image along one or more axis
#[derive(Debug, Clone, Parser, Serialize, Deserialize)]
#[clap(author, version = "0.3.0")]
pub struct Flip {
- /// The path to the spritesheet file
+ /// The path to the image file
#[serde(default)]
pub input: String,
- /// The path to write the extruded spritesheet
+ /// The path to write the flipped image
#[serde(default)]
pub output: String,
diff --git a/src/commands/palette.rs b/src/commands/palette.rs
index 0c489a8..60c9003 100644
--- a/src/commands/palette.rs
+++ b/src/commands/palette.rs
@@ -38,10 +38,10 @@ pub fn sort_by_hue(palette: &mut PixelPalette) {
#[derive(Parser, Clone, Serialize, Deserialize, Debug)]
#[clap(author, version = "0.3.0")]
pub struct Palette {
- /// The path to the spritesheet file
+ /// The path to the image file
#[serde(default)]
pub input: String,
- /// The path to write the extruded spritesheet
+ /// The path to write the palette data
#[serde(default)]
pub output: String,
diff --git a/src/commands/pipeline.rs b/src/commands/pipeline.rs
index 724e336..a538fc5 100644
--- a/src/commands/pipeline.rs
+++ b/src/commands/pipeline.rs
@@ -49,7 +49,7 @@ pub struct PipelineFile {
pub pipelines: Vec<PipelineType>,
}
-/// Rotate an image clockwise by the given degree
+/// Execute a predefined pipeline
#[derive(Debug, Clone, Parser, Serialize, Deserialize)]
#[clap(author, version = "0.3.0")]
pub struct Pipeline {
diff --git a/src/commands/remap.rs b/src/commands/remap.rs
index 8e34444..342999a 100644
--- a/src/commands/remap.rs
+++ b/src/commands/remap.rs
@@ -6,14 +6,14 @@ use serde::{Deserialize, Serialize};
use crate::utils::{new_image, BasicRgba, OutputFormat, TypedOutputFormat};
-/// Rotate an image clockwise by the given degree
+/// Convert the colour space of an image to that of a given palette file
#[derive(Debug, Clone, Parser, Serialize, Deserialize)]
#[clap(author, version = "0.3.0")]
pub struct Remap {
- /// The path to the spritesheet file
+ /// The path to the image file
#[serde(default)]
pub input: String,
- /// The path to write the extruded spritesheet
+ /// The path to write the recoloured image
#[serde(default)]
pub output: String,
diff --git a/src/commands/scale.rs b/src/commands/scale.rs
index f9933ff..5f3b2c8 100644
--- a/src/commands/scale.rs
+++ b/src/commands/scale.rs
@@ -9,14 +9,14 @@ fn one() -> f32 {
1.0
}
-/// Rotate an image clockwise by the given degree
+/// Resize an image by a scale factor
#[derive(Debug, Clone, Parser, Serialize, Deserialize)]
#[clap(author, version = "0.3.0")]
pub struct Scale {
- /// The path to the spritesheet file
+ /// The path to the image file
#[serde(default)]
pub input: String,
- /// The path to write the extruded spritesheet
+ /// The path to write the scaled image
#[serde(default)]
pub output: String,
--
GitLab