Skip to content

Commit fff729a

Browse files
tansongyangkategengler
authored andcommitted
[DOC RouteInfo] Fix grammar, spelling, and formatting
(cherry picked from commit 8693674)
1 parent b179dfd commit fff729a

3 files changed

Lines changed: 12 additions & 10 deletions

File tree

packages/@ember/-internals/routing/lib/services/router.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,8 +293,8 @@ if (EMBER_ROUTING_ROUTER_SERVICE) {
293293
});
294294
},
295295

296-
/**
297-
A RouteInfo that represents the current leaf route.
296+
/**
297+
A `RouteInfo` that represents the current leaf route.
298298
It is guaranteed to change whenever a route transition
299299
happens (even when that transition only changes parameters
300300
and doesn't change the active route)

packages/@ember/-internals/routing/lib/system/route-info.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
/**
4343
The ordered list of the names of the params
4444
required for this route. It will contain the same
45-
strings as Object.keys(params), but here the order
45+
strings as `Object.keys(params)`, but here the order
4646
is significant. This allows users to correctly pass
4747
params into routes programmatically.
4848
@property {Array} paramNames
@@ -153,9 +153,9 @@
153153
*/
154154

155155
/**
156-
The values of the route's parametes. These are the
156+
The values of the route's parameters. These are the
157157
same params that are received as arguments to the
158-
route's model hook. Contains only the parameters
158+
route's `model` hook. Contains only the parameters
159159
valid for this route, if any (params for parent or
160160
child routes are not merged).
161161
@property {Object} params
@@ -182,7 +182,7 @@
182182
*/
183183

184184
/**
185-
A reference to the parent route's RouteInfo.
185+
A reference to the parent route's `RouteInfo`.
186186
This can be used to traverse upward to the topmost
187187
`RouteInfo`.
188188
@property {RouteInfo|null} parent
@@ -191,7 +191,7 @@
191191
*/
192192

193193
/**
194-
A reference to the child route's RouteInfo.
194+
A reference to the child route's `RouteInfo`.
195195
This can be used to traverse downward to the
196196
leafmost `RouteInfo`.
197197
@property {RouteInfo|null} child
@@ -202,7 +202,9 @@
202202
of `RouteInfo`s from the topmost to leafmost.
203203
Returns the first `RouteInfo` in the linked list
204204
for which the callback returns true.
205+
*/
205206

207+
/**
206208
This method is similar to the `find()` method
207209
defined in ECMAScript 2015.
208210

packages/@ember/-internals/routing/lib/system/transition.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
* This property is a `RouteInfo` object that represents
139139
* where the router is transitioning to. It's important
140140
* to note that a `RouteInfo` is a linked list and this
141-
* property is simply represents leafmost route.
141+
* property represents the leafmost route.
142142
* @property {RouteInfo|RouteInfoWithAttributes} to
143143
* @public
144144
* @category ember-routing-router-service
@@ -148,8 +148,8 @@
148148
* This property is a `RouteInfo` object that represents
149149
* where transition originated from. It's important
150150
* to note that a `RouteInfo` is a linked list and this
151-
* property is simply represents head node of the list.
152-
* In the case of an initial render, from will be set to
151+
* property represents the head node of the list.
152+
* In the case of an initial render, `from` will be set to
153153
* `null`.
154154
* @property {RouteInfoWithAttributes} from
155155
* @public

0 commit comments

Comments
 (0)