chore(ai-test): document args

mdn · Feb 5, 2024 · 28635c6 · 28635c6
1 parent e3402c0
commit 28635c6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/ai-test/README.md b/ai-test/README.md
@@ -10,9 +10,10 @@ To understand how this tool works, run: `cargo run -p ai-test -- test --help`
 Usage: ai-test test [OPTIONS]
 
 Options:
-  -p, --path <PATH>  
-  -o, --out <OUT>    
-  -h, --help         Print help
+  -p, --path <PATH>      Path to YAML file with list of lists (initial question + follow-up questions)
+  -o, --out <OUT>        Path to directory to write the test results as `1.json`, `1.md`, etc
+      --no-subscription  Perform test as free Core user without subscription
+  -h, --help             Print help
 ```
 
 For example, to request answers for all questions in the [prompts.yaml](./data/prompts.yaml) file, run (from the repository root):

diff --git a/ai-test/src/main.rs b/ai-test/src/main.rs
@@ -22,10 +22,13 @@ struct Cli {
 #[derive(Subcommand)]
 enum Commands {
     Test {
+        /// Path to YAML file with list of lists (initial question + follow-up questions).
         #[arg(short, long)]
         path: Option<PathBuf>,
+        /// Path to directory to write the test results as `1.json`, `1.md`, etc.
         #[arg(short, long)]
         out: Option<PathBuf>,
+        /// Perform test as free Core user without subscription.
         #[arg(long, action)]
         no_subscription: bool,
     },