fix comment

jay-hodgson · Oct 27, 2023 · 1e550a1 · 1e550a1
1 parent 6a6e016
commit 1e550a1
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/apps/portals/src/portal-components/RedirectToURL.tsx b/apps/portals/src/portal-components/RedirectToURL.tsx
@@ -6,7 +6,8 @@ export type RedirectToURLProps = {
 }
 
 /**
- * Allows us to use react-router's Redirect as a portal component without losing the query params.
+ * Allows us to redirect to an arbitrary URL.  If search is provided, then it will only redirect if the
+ * search parameter matches this string.
  * @param props
  * @returns
  */