Adding clarifications to some docblocks

MatrixAI · Feb 14, 2022 · 73c6d0f · 73c6d0f
1 parent a360302
commit 73c6d0f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/bin/utils/parsers.ts b/src/bin/utils/parsers.ts
@@ -22,7 +22,8 @@ function validateParserToArgParser<T>(
 }
 
 /**
- * Converts a validation parser to commander variadic argument parser
+ * Converts a validation parser to commander variadic argument parser.
+ * Variadic options/arguments are always space-separated.
  */
 function validateParserToArgListParser<T>(
   validate: (data: string) => T,
@@ -99,9 +100,9 @@ export {
   parsePort,
   parseNetwork,
   parseSeedNodes,
+  parseProviderId,
+  parseIdentityId,
+  parseProviderIdList,
   parseCoreCount,
   parseSecretPath,
-  parseProviderIdList,
-  parseIdentityId,
-  parseProviderId,
 };
diff --git a/src/identities/utils.ts b/src/identities/utils.ts
@@ -51,6 +51,9 @@ function browser(url: string): void {
 
 /**
  * Check whether a given identity matches at least one search term from a list.
+ * Use this to filter a list of identiy datas e.g. filtering connected
+ * identities or a list of identity lookups.
+ * If the provider has a native search ability, use that instead of this.
  */
 function matchIdentityData(
   identityData: IdentityData,