From 4a7a64985287e359125cee6b91ddd315526049b4 Mon Sep 17 00:00:00 2001
From: markostanimirovic <markostanimirovic95@gmail.com>
Date: Mon, 11 Jan 2021 01:55:27 +0100
Subject: [PATCH] docs(router): clarify the description of legacy
 relativeLinkResolution (#40384)

PR Close #40384
---
 packages/router/src/router_module.ts | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/packages/router/src/router_module.ts b/packages/router/src/router_module.ts
index 81bc596475..26e2a4ce6d 100644
--- a/packages/router/src/router_module.ts
+++ b/packages/router/src/router_module.ts
@@ -411,7 +411,9 @@ export interface ExtraOptions {
    * ];
    * ```
    *
-   * From the `ContainerComponent`, this will not work:
+   * From the `ContainerComponent`, you should be able to navigate to `AComponent` using
+   * the following `routerLink`, but it will not work if `relativeLinkResolution` is set
+   * to `'legacy'`:
    *
    * `<a [routerLink]="['./a']">Link to A</a>`
    *
@@ -419,7 +421,8 @@ export interface ExtraOptions {
    *
    * `<a [routerLink]="['../a']">Link to A</a>`
    *
-   * In other words, you're required to use `../` rather than `./`.
+   * In other words, you're required to use `../` rather than `./` when the relative link
+   * resolution is set to `'legacy'`.
    *
    * The default in v11 is `corrected`.
    */