docs: Document types input parser's return types

alorel-actions · Sep 17, 2023 · b6c3972 · b6c3972
1 parent bff2615
commit b6c3972
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/lib/types-input-parser.mts b/src/lib/types-input-parser.mts
@@ -19,7 +19,10 @@ class TypesInputParser<T> {
     return () => this.parseInput(inputName);
   }
 
-  /** Parse an input with the given name */
+  /**
+   * Parse an input with the given name
+   * @return The types we detected
+   */
   public parseInput(name: string & TypedKeys<T, Set<string>>): Set<string> {
     const regex = /^\s*([^:]+):\s*([^\n]+)$/;
     const out = new Set<string>();