Update doc comments

Arnesfield · Mar 24, 2024 · 03d485d · 03d485d
1 parent 8c9dc1b
commit 03d485d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/core/core.types.ts b/src/core/core.types.ts
@@ -4,6 +4,9 @@
 export interface Options {
   /**
    * Unique ID for this option or command.
+   *
+   * This is never used in any internal logic, but can
+   * be useful for finding the exact node after parsing.
    */
   id?: string;
   /**

diff --git a/src/core/error.ts b/src/core/error.ts
@@ -57,7 +57,7 @@ export class ArgsTreeError extends Error {
    */
   static readonly INVALID_OPTIONS_ERROR = 'invalid-options';
   /**
-   * The Node did not satisfy the number of arguments.
+   * The Node did not satisfy the required number of arguments.
    */
   static readonly INVALID_RANGE_ERROR = 'invalid-range';
   /**