API docs update

dekelev · Feb 7, 2018 · 9c07457 · 9c07457
1 parent 1b5f139
commit 9c07457
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 18 deletions.
diff --git a/doc/option-definition.md b/doc/option-definition.md
@@ -32,7 +32,7 @@ const optionDefinitions = [
 
 Where a `type` property is not specified it will default to `String`.
 
-| #   | Command line args | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | -------------------- | ------------ |
 | 1   | `--file` | `{ file: null }` |
 | 2   | `--file lib.js` | `{ file: 'lib.js' }` |
@@ -71,13 +71,13 @@ const cli = commandLineArgs([
 ])
 ```
 
-| #   | Command line args| .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ----------------- | ------------ |
 | 1   | `--file asdf.txt` | `{ file: { filename: 'asdf.txt', exists: false } }` |
 
 The `--depth` option expects a `Number`. If no value was set, you will receive `null`.
 
-| #   | Command line args | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ----------------- | ------------ |
 | 2   | `--depth` | `{ depth: null }` |
 | 3   | `--depth 2` | `{ depth: 2 }` |
@@ -97,7 +97,7 @@ const optionDefinitions = [
 ]
 ```
 
-| #   | Command line | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ------------ | ------------ |
 | 1   | `-hcd` | `{ hot: true, courses: null, discount: true }` |
 | 2   | `-hdc 3` | `{ hot: true, discount: true, courses: 3 }` |
@@ -116,7 +116,7 @@ const optionDefinitions = [
 
 Note, examples 1 and 3 below demonstrate "greedy" parsing which can be disabled by using `lazyMultiple`.
 
-| #   | Command line | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ------------ | ------------ |
 | 1   | `--files one.js two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
 | 2   | `--files one.js --files two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
@@ -135,7 +135,7 @@ const optionDefinitions = [
 ]
 ```
 
-| #   | Command line | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ------------ | ------------ |
 | 1   | `--files one.js --files two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
 | 2   | `-vvv` | `{ verbose: [ true, true, true ] }` |
@@ -152,7 +152,7 @@ const optionDefinitions = [
 ]
 ```
 
-| #   | Command line | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ------------ | ------------ |
 | 1   | `--files one.js two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
 | 2   | `one.js two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
@@ -171,7 +171,7 @@ const optionDefinitions = [
 ]
 ```
 
-| #   | Command line | .parse() output |
+| #   | argv input | commandLineArgs() output |
 | --- | ------------ | ------------ |
 | 1   |  | `{ files: [ 'one.js' ], max: 3 }` |
 | 2   | `--files two.js` | `{ files: [ 'two.js' ], max: 3 }` |
@@ -197,7 +197,7 @@ const optionDefinitions = [
 
 <table>
  <tr>
-   <th>#</th><th>Command Line</th><th>.parse() output</th>
+   <th>#</th><th>Command Line</th><th>commandLineArgs() output</th>
  </tr>
  <tr>
    <td>1</td><td><code>--verbose</code></td><td><pre><code>

diff --git a/lib/option-definition.js b/lib/option-definition.js
@@ -24,7 +24,7 @@ class OptionDefinition {
     *
     * Where a `type` property is not specified it will default to `String`.
     *
-    * | #   | Command line args | .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | -------------------- | ------------ |
     * | 1   | `--file` | `{ file: null }` |
     * | 2   | `--file lib.js` | `{ file: 'lib.js' }` |
@@ -63,13 +63,13 @@ class OptionDefinition {
     * ])
     * ```
     *
-    * | #   | Command line args| .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | ----------------- | ------------ |
     * | 1   | `--file asdf.txt` | `{ file: { filename: 'asdf.txt', exists: false } }` |
     *
     * The `--depth` option expects a `Number`. If no value was set, you will receive `null`.
     *
-    * | #   | Command line args | .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | ----------------- | ------------ |
     * | 2   | `--depth` | `{ depth: null }` |
     * | 3   | `--depth 2` | `{ depth: 2 }` |
@@ -90,7 +90,7 @@ class OptionDefinition {
     * ]
     * ```
     *
-    * | #   | Command line | .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | ------------ | ------------ |
     * | 1   | `-hcd` | `{ hot: true, courses: null, discount: true }` |
     * | 2   | `-hdc 3` | `{ hot: true, discount: true, courses: 3 }` |
@@ -110,7 +110,7 @@ class OptionDefinition {
     *
     * Note, examples 1 and 3 below demonstrate "greedy" parsing which can be disabled by using `lazyMultiple`.
     *
-    * | #   | Command line | .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | ------------ | ------------ |
     * | 1   | `--files one.js two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
     * | 2   | `--files one.js --files two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
@@ -130,7 +130,7 @@ class OptionDefinition {
      * ]
      * ```
      *
-     * | #   | Command line | .parse() output |
+     * | #   | argv input | commandLineArgs() output |
      * | --- | ------------ | ------------ |
      * | 1   | `--files one.js --files two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
      * | 2   | `-vvv` | `{ verbose: [ true, true, true ] }` |
@@ -148,7 +148,7 @@ class OptionDefinition {
     * ]
     * ```
     *
-    * | #   | Command line | .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | ------------ | ------------ |
     * | 1   | `--files one.js two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
     * | 2   | `one.js two.js` | `{ files: [ 'one.js', 'two.js' ] }` |
@@ -168,7 +168,7 @@ class OptionDefinition {
     * ]
     * ```
     *
-    * | #   | Command line | .parse() output |
+    * | #   | argv input | commandLineArgs() output |
     * | --- | ------------ | ------------ |
     * | 1   |  | `{ files: [ 'one.js' ], max: 3 }` |
     * | 2   | `--files two.js` | `{ files: [ 'two.js' ], max: 3 }` |
@@ -195,7 +195,7 @@ class OptionDefinition {
     *
     *<table>
     *  <tr>
-    *    <th>#</th><th>Command Line</th><th>.parse() output</th>
+    *    <th>#</th><th>Command Line</th><th>commandLineArgs() output</th>
     *  </tr>
     *  <tr>
     *    <td>1</td><td><code>--verbose</code></td><td><pre><code>