fixup! docs: add detail to router event doc

angular · Aug 14, 2019 · 4b986f2 · 4b986f2
1 parent e135ad0
commit 4b986f2
Showing 1 changed file with 1 addition and 4 deletions.
diff --git a/packages/router/src/events.ts b/packages/router/src/events.ts
@@ -125,10 +125,7 @@ export class NavigationEnd extends RouterEvent {
  * An event triggered when a navigation is canceled, directly or indirectly.
  *
  * This can happen when a [route guard](guide/router#milestone-5-route-guards)
- * returns `false` (or a promise that resolves to `false`,
- * or an observable that emits `false`).
- * The current navigation is also canceled when a route guard
- * initiates redirect.
+ * returns `false` or initiates a redirect by returning a `UrlTree`.
  *
  * @publicApi
  */