Skip to content

Commit

Permalink
fix(docs): Explain return value of rule as function
Browse files Browse the repository at this point in the history
  • Loading branch information
timkindberg committed Jul 16, 2014
1 parent e07a794 commit 5e88789
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/urlRouter.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,14 @@ function $UrlRouterProvider( $locationProvider, $urlMatcherFactory) {
*
* // Example of using function rule as param
* $urlRouterProvider.otherwise(function ($injector, $location) {
* ...
* return '/a/valid/url';
* });
* });
* </pre>
*
* @param {string|object} rule The url path you want to redirect to or a function
* rule that returns the url path. The function version is passed two params:
* `$injector` and `$location` services.
* `$injector` and `$location` services, and must return a url string.
*
* @return {object} `$urlRouterProvider` - `$urlRouterProvider` instance
*/
Expand Down

0 comments on commit 5e88789

Please sign in to comment.