Update CLI docs

doc/dev.md

@@ -82,17 +82,17 @@ The following is the full list of arguments (which can also be accessed by passi
 | Argument | Value | Default | Description |
 | --- | --- | --- | --- |
 | `-e`, `--lrs-endpoint` | URI | <details>`http://0.0.0.0:8080/xapi/statements`<summary>(URI)</summary></details> | The HTTP(S) endpoint of the (SQL) LRS webserver for Statement POSTs and GETs. |
-| `-i`, `--insert-input` | Filepath | None | The location of a JSON file containing a DATASIM input spec. If given, this input is used to insert statements into the DB. |
-| `-s`, `--input-size` | Integer | `1000` | The total number of statements to insert. Ignored if `-i` is not given. |
-| `-b`, `--batch-size` | Integer | `10` | The batch size to use for inserting statements. Ignored if `-i` is not given. |
-| `-a`, `--async?` | Boolean | `false` | Whether to insert asynchronously or not. |
-| `-c`, `--concurrency` | Integer | `10` | The number of parallel threads to run during statement insertion and querying. Ignored if `-a` is `false`. |
+| `-i`, `--insert-input` | Filepath | None | The location of a JSON file containing a DATASIM input spec. If present, this input is used to insert statements into the DB. |
+| `-s`, `--input-size` | Integer | `1000` | The total number of statements to insert. Ignored if `-i` is not present. |
+| `-b`, `--batch-size` | Integer | `10` | The batch size to use for inserting statements. Ignored if `-i` is not present. |
+| `-a`, `--async` | No args | N/A | If provided, insert statements asynchronously. |
+| `-c`, `--concurrency` | Integer | `10` | The number of parallel threads to run during statement insertion and querying. Ignored if `-a` is not present. |
 | `-r`, `--statement-refs` | Keyword | `none` | How Statement References should be generated and inserted. Valid options are `none` (no Statement References), `half` (half of the Statements have StatementRef objects), and `all` (all Statements have StatementRef objects). |
-| `-q`, `--query-input` | Filepath | None | The location of a JSON file containing an array of statement query params. If not given, the benchmark does a single query with no params. |
+| `-q`, `--query-input` | Filepath | None | The location of a JSON file containing an array of statement query params. If not present, the benchmark does a single query with no params. |
 | `-n`, `--query-number` | Integer | `30` | The number of times each query is performed. |
 | `-u`, `--user` | String | None | HTTP Basic Auth user. |
 | `-p`, `--pass` | String | None | HTTP Basic Auth password. |
-| `-h`, `--help` | No args | None | Help menu. |
+| `-h`, `--help` | No args | N/A | Help menu. |
 
 #### 5. Wait for results
 

src/bench/lrsql/bench.clj

@@ -26,26 +26,26 @@
     :desc    "The HTTP(S) endpoint of the (SQL) LRS webserver for Statement POSTs and GETs."]
    ["-i" "--insert-input URI" "DATASIM input source"
     :id   :insert-input
-    :desc "The location of a JSON file containing a DATASIM input spec. If given, this input is used to insert statements into the DB."]
+    :desc "The location of a JSON file containing a DATASIM input spec. If present, this input is used to insert statements into the DB."]
    ["-s" "--input-size LONG" "Size"
     :id       :insert-size
     :parse-fn #(Long/parseLong %)
     :default  1000
-    :desc     "The total number of statements to insert. Ignored if `-i` is not given."]
+    :desc     "The total number of statements to insert. Ignored if `-i` is not present."]
    ["-b" "--batch-size LONG" "Statements per batch"
     :id       :batch-size
     :parse-fn #(Long/parseLong %)
     :default  10
-    :desc     "The batch size to use for inserting statements. Ignored if `-i` is not given."]
+    :desc     "The batch size to use for inserting statements. Ignored if `-i` is not present."]
    ["-a" "--async" "Run asynchronously?"
     :id      :async?
     :default false
-    :desc    "Whether to insert asynchronously or not."]
+    :desc    "If provided, insert statements asynchronously."]
    ["-c" "--concurrency LONG" "Number of threads"
     :id       :concurrency
     :parse-fn #(Long/parseLong %)
     :default  10
-    :desc     "The number of parallel threads to run during statement insertion. Ignored if `-a` is `false`."]
+    :desc     "The number of parallel threads to run during statement insertion. Ignored if `-a` is not present."]
    ["-r" "--statement-refs STRING" "Statement Ref Insertion Type"
     :id       :statement-ref-type
     :parse-fn keyword
@@ -54,7 +54,7 @@
     :desc     "How Statement References should be generated and inserted. Valid options are none (no Statement References), half (half of the Statements have StatementRef objects), and all (all Statements have StatementRef objects)."]
    ["-q" "--query-input URI" "Query input source"
     :id   :query-input
-    :desc "The location of a JSON file containing an array of statement query params. If not given, the benchmark does a single query with no params."]
+    :desc "The location of a JSON file containing an array of statement query params. If not present, the benchmark does a single query with no params."]
    ["-n" "--query-number LONG" "Query execution number"
     :id       :query-number
     :parse-fn #(Long/parseLong %)