docs(ngRoute): clarify when gets updated

petebacondarwin · petebacondarwin · commit 1fac36e2cb70 · 2013-06-11T22:35:47.000+01:00
diff --git a/src/ng/route.js b/src/ng/route.js
@@ -24,8 +24,8 @@ function $RouteProvider(){
    *    route definition.
    *
    *    `path` can contain named groups starting with a colon (`:name`). All characters up to the
-   *    next slash are matched and stored in `$routeParams` under the given `name` when the route
-   *    matches.
+   *    next slash are matched and stored in `$routeParams` under the given `name` after the route
+   *    is resolved.
    *
    * @param {Object} route Mapping information to be assigned to `$route.current` on route
    *    match.
@@ -50,7 +50,9 @@ function $RouteProvider(){
    *      - `factory` - `{string|function}`: If `string` then it is an alias for a service.
    *        Otherwise if function, then it is {@link api/AUTO.$injector#invoke injected}
    *        and the return value is treated as the dependency. If the result is a promise, it is resolved
-   *        before its value is injected into the controller.
+   *        before its value is injected into the controller. Be aware that `ngRoute.$routeParams` will
+   *        still refer to the previous route within these resolve functions.  Use `$route.current.params`
+   *        to access the new route parameters, instead.
    *
    *    - `redirectTo` – {(string|function())=} – value to update
    *      {@link ng.$location $location} path with and trigger route redirection.
diff --git a/src/ng/routeParams.js b/src/ng/routeParams.js
@@ -15,6 +15,10 @@
  * The service guarantees that the identity of the `$routeParams` object will remain unchanged
  * (but its properties will likely change) even when a route change occurs.
  *
+ * Note that the `$routeParams` are only updated *after* a route change completes successfully.
+ * This means that you cannot rely on `$routeParams` being correct in route resolve functions.
+ * Instead you can use `$route.current.params` to access the new route's parameters.
+ *
  * @example
  * <pre>
  *  // Given:
