Add clearer documentation

Signed-off-by: sblausten <sam@roadie.io>
2022-06-30 11:50:26 +02:00
parent 3c84892796
commit 156bb8ffba
1 changed files with 2 additions and 2 deletions
@@ -52,10 +52,10 @@ export interface TechInsightsOptions<
  CheckResultType extends CheckResult,
 > {
  /**
-   * Optional collection of FactRetrieverRegistrations.
+   * Optional collection of FactRetrieverRegistrations (required if no factRetrieverRegistry passed in).
   * Used to register FactRetrievers and their schemas and schedule an execution loop for them.
   *
-   * Not needed if passing in your own FactRetrieverRegistry implementation
+   * Not needed if passing in your own FactRetrieverRegistry implementation. Required otherwise.
   */
  factRetrievers?: FactRetrieverRegistration[];