Skip to content

Commit 964e734

Browse files
committed
tweak getRouteStringFromRoutes docstring
1 parent ee4684b commit 964e734

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

static/app/utils/getRouteStringFromRoutes.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ export type Props =
2020
* It will look for the last route path that begins with a `/` and
2121
* concatenate all of the following routes. Skips any routes without a path
2222
*
23-
* @param params.routes An array of route objects from react-router
23+
* @param params.matches An array of UIMatch objects from react-router-dom `useMatches()`
24+
* @param @deprecated params.routes An array of route objects from react-router
2425
* @returns A route path string
2526
*/
2627
export function getRouteStringFromRoutes({routes, matches}: Props): string {

0 commit comments

Comments
 (0)