update docstring

Opentrons · Feb 8, 2024 · 6d0a8f0 · 6d0a8f0
1 parent 4ce7736
commit 6d0a8f0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/react-api-client/src/runs/useAllRunsQuery.ts b/react-api-client/src/runs/useAllRunsQuery.ts
@@ -13,6 +13,10 @@ export type UseAllRunsQueryOptions = UseQueryOptions<
   Array<string | HostConfig>
 >
 
+/**
+ * @property {HostConfig | null | undefined} hostOverride:
+ * When using all runs query outside of the host context provider, we must specify the host manually.
+ */
 export function useAllRunsQuery(
   params: GetRunsParams = {},
   options: UseAllRunsQueryOptions = {},