From a77ff1c820c7878eec6ba160ec2ebaf40f5f0cdc Mon Sep 17 00:00:00 2001 From: Brian Donovan <1938+eventualbuddha@users.noreply.github.com> Date: Fri, 4 Aug 2023 15:00:41 -0700 Subject: [PATCH] docs(cli): update subcommand comments (#1303) A bunch of these were copy-pasted from `build`. This commit updates them to be the same as what their `dx help` string is. --- packages/cli/docs/src/cmd/README.md | 1 + packages/cli/src/cli/autoformat.rs | 2 +- packages/cli/src/cli/bundle.rs | 2 +- packages/cli/src/cli/config.rs | 2 +- packages/cli/src/cli/mod.rs | 1 + packages/cli/src/cli/plugin.rs | 2 +- packages/cli/src/cli/translate.rs | 2 +- packages/cli/src/cli/version.rs | 2 +- 8 files changed, 8 insertions(+), 6 deletions(-) diff --git a/packages/cli/docs/src/cmd/README.md b/packages/cli/docs/src/cmd/README.md index 93f6f5573..735794635 100644 --- a/packages/cli/docs/src/cmd/README.md +++ b/packages/cli/docs/src/cmd/README.md @@ -15,6 +15,7 @@ Commands: serve Build, watch & serve the Rust WASM app and all of its assets create Init a new project for Dioxus clean Clean output artifacts + bundle Bundle the Rust desktop app and all of its assets version Print the version of this extension fmt Format some rsx check Check the Rust files in the project for issues diff --git a/packages/cli/src/cli/autoformat.rs b/packages/cli/src/cli/autoformat.rs index a0c0a8066..f436ab4c4 100644 --- a/packages/cli/src/cli/autoformat.rs +++ b/packages/cli/src/cli/autoformat.rs @@ -6,7 +6,7 @@ use super::*; // For reference, the rustfmt main.rs file // https://github.com/rust-lang/rustfmt/blob/master/src/bin/main.rs -/// Build the Rust WASM app and all of its assets. +/// Format some rsx #[derive(Clone, Debug, Parser)] pub struct Autoformat { /// Run in 'check' mode. Exits with 0 if input is formatted correctly. Exits diff --git a/packages/cli/src/cli/bundle.rs b/packages/cli/src/cli/bundle.rs index 76c494056..0d4fb23da 100644 --- a/packages/cli/src/cli/bundle.rs +++ b/packages/cli/src/cli/bundle.rs @@ -6,7 +6,7 @@ use tauri_bundler::{BundleSettings, PackageSettings, SettingsBuilder}; use super::*; use crate::{build_desktop, cfg::ConfigOptsBundle}; -/// Build the Rust WASM app and all of its assets. +/// Bundle the Rust desktop app and all of its assets #[derive(Clone, Debug, Parser)] #[clap(name = "bundle")] pub struct Bundle { diff --git a/packages/cli/src/cli/config.rs b/packages/cli/src/cli/config.rs index cde29ef6a..45fcc2f23 100644 --- a/packages/cli/src/cli/config.rs +++ b/packages/cli/src/cli/config.rs @@ -1,6 +1,6 @@ use super::*; -/// Build the Rust WASM app and all of its assets. +/// Dioxus config file controls #[derive(Clone, Debug, Deserialize, Subcommand)] #[clap(name = "config")] pub enum Config { diff --git a/packages/cli/src/cli/mod.rs b/packages/cli/src/cli/mod.rs index 37d64d2f3..9b3be33bc 100644 --- a/packages/cli/src/cli/mod.rs +++ b/packages/cli/src/cli/mod.rs @@ -72,6 +72,7 @@ pub enum Commands { #[clap(name = "fmt")] Autoformat(autoformat::Autoformat), + /// Check the Rust files in the project for issues. #[clap(name = "check")] Check(check::Check), diff --git a/packages/cli/src/cli/plugin.rs b/packages/cli/src/cli/plugin.rs index 9f514edec..43375f700 100644 --- a/packages/cli/src/cli/plugin.rs +++ b/packages/cli/src/cli/plugin.rs @@ -2,7 +2,7 @@ use super::*; -/// Build the Rust WASM app and all of its assets. +/// Manage plugins for dioxus cli #[derive(Clone, Debug, Deserialize, Subcommand)] #[clap(name = "plugin")] pub enum Plugin { diff --git a/packages/cli/src/cli/translate.rs b/packages/cli/src/cli/translate.rs index a922d428d..d3901e651 100644 --- a/packages/cli/src/cli/translate.rs +++ b/packages/cli/src/cli/translate.rs @@ -4,7 +4,7 @@ use dioxus_rsx::{BodyNode, CallBody}; use super::*; -/// Build the Rust WASM app and all of its assets. +/// Translate some source file into Dioxus code #[derive(Clone, Debug, Parser)] #[clap(name = "translate")] pub struct Translate { diff --git a/packages/cli/src/cli/version.rs b/packages/cli/src/cli/version.rs index 3c77ba419..c015a73a2 100644 --- a/packages/cli/src/cli/version.rs +++ b/packages/cli/src/cli/version.rs @@ -1,6 +1,6 @@ use super::*; -/// Build the Rust WASM app and all of its assets. +/// Print the version of this extension #[derive(Clone, Debug, Parser)] #[clap(name = "version")] pub struct Version {}