Skip to content

Commit cd2050b

Browse files
0x-r4bbitbtford
authored andcommitted
docs(router): route alias has to be written in PascalCase
Closes angular#4547
1 parent 075011f commit cd2050b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

modules/angular2/src/router/router_link.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ import {Instruction, stringifyInstruction} from './instruction';
1212
1313
* ```
1414
* @RouteConfig([
15-
* { path: '/user', component: UserCmp, as: 'user' }
15+
* { path: '/user', component: UserCmp, as: 'User' }
1616
* ]);
1717
* class MyComp {}
1818
* ```
1919
*
20-
* When linking to this `user` route, you can write:
20+
* When linking to this `User` route, you can write:
2121
*
2222
* ```
23-
* <a [router-link]="['./user']">link to user component</a>
23+
* <a [router-link]="['./User']">link to user component</a>
2424
* ```
2525
*
2626
* RouterLink expects the value to be an array of route names, followed by the params
27-
* for that level of routing. For instance `['/team', {teamId: 1}, 'user', {userId: 2}]`
28-
* means that we want to generate a link for the `team` route with params `{teamId: 1}`,
29-
* and with a child route `user` with params `{userId: 2}`.
27+
* for that level of routing. For instance `['/Team', {teamId: 1}, 'User', {userId: 2}]`
28+
* means that we want to generate a link for the `Team` route with params `{teamId: 1}`,
29+
* and with a child route `User` with params `{userId: 2}`.
3030
*
3131
* The first route name should be prepended with `/`, `./`, or `../`.
3232
* If the route begins with `/`, the router will look up the route from the root of the app.

0 commit comments

Comments
 (0)