Merge pull request #33 from KnpLabs/fix/doc-cli-args

[RFR] indicate that any git node is a valid `path` arg
KnpLabs · Oct 17, 2022 · 02ec398 · 02ec398
2 parents fc85f26 + b0ba5ea
commit 02ec398
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ OPTIONS:
                                    find the merge base). [default: master]
     --cmd <cmd>                    The command to use to skip the build.
     --path <paths>...              The path to inspect. Defaults to cwd. This arg can be specified multiple times to
-                                   inspect multiple paths.
+                                   inspect multiple paths. A path should point to any git node in the source tree.
     --remote <remote>              The name of the tracked repository. [default: origin]
 ```
 

diff --git a/src/cli.rs b/src/cli.rs
@@ -6,7 +6,7 @@ use structopt::StructOpt;
 #[derive(StructOpt)]
 #[structopt(name = "ssc", about = "should-skip-ci")]
 struct RawCli {
-    #[structopt(long = "path", help = "The path to inspect. Defaults to cwd. This arg can be specified multiple times to inspect multiple paths.")]
+    #[structopt(long = "path", help = "The path to inspect. Defaults to cwd. This arg can be specified multiple times to inspect multiple paths. A path should point to any git node in the source tree.")]
     paths: Vec<PathBuf>,
 
     #[structopt(long = "remote", default_value = "origin", help = "The name of the tracked repository.")]