docs: add documentation to cli (#912)

quarylabs · Oct 30, 2024 · 966fda4 · 966fda4
1 parent 63ed288
commit 966fda4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/crates/cli/src/commands.rs b/crates/cli/src/commands.rs
@@ -28,13 +28,15 @@ pub(crate) enum Commands {
 
 #[derive(Debug, Parser)]
 pub(crate) struct LintArgs {
+    /// Files or directories to fix.
     pub paths: Vec<PathBuf>,
     #[arg(default_value = "human", short, long)]
     pub format: Format,
 }
 
 #[derive(Debug, Parser)]
 pub(crate) struct FixArgs {
+    /// Files or directories to fix.
     pub paths: Vec<PathBuf>,
     /// Skip the confirmation prompt and go straight to applying fixes.
     #[arg(long)]

diff --git a/docs/cli.md b/docs/cli.md
@@ -35,7 +35,7 @@ lint files
 
 ###### **Arguments:**
 
-* `<PATHS>`
+* `<PATHS>` — Files or directories to fix
 
 ###### **Options:**
 
@@ -56,7 +56,7 @@ fix files
 
 ###### **Arguments:**
 
-* `<PATHS>`
+* `<PATHS>` — Files or directories to fix
 
 ###### **Options:**