Skip to content

Commit

Permalink
Explain why route shadowing should be avoided in `no-shadow-route-def…
Browse files Browse the repository at this point in the history
…inition` rule doc (#1783)
  • Loading branch information
spuxx1701 authored Feb 14, 2023
1 parent e0e3c48 commit f99ee4d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/rules/no-shadow-route-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Enforce no route path definition shadowing in Router.

## Rule Details

This rule disallows defining shadowing route definitions.
This rule disallows defining shadowing route definitions. Shadowing will result in the router failing to resolve the path of the shadowed route, leading to undesirable and incomprehensible behavior (e.g. hooks of the shadowed route not firing even though the URL matches its path).

## Examples

Expand Down

0 comments on commit f99ee4d

Please sign in to comment.