From 5e8878900a6ffe59a81aed531a3925e34a297377 Mon Sep 17 00:00:00 2001 From: Tim Kindberg Date: Tue, 15 Jul 2014 22:24:44 -0400 Subject: [PATCH] fix(docs): Explain return value of rule as function --- src/urlRouter.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/urlRouter.js b/src/urlRouter.js index e4a76524f..eec2dfa22 100644 --- a/src/urlRouter.js +++ b/src/urlRouter.js @@ -88,14 +88,14 @@ function $UrlRouterProvider( $locationProvider, $urlMatcherFactory) { * * // Example of using function rule as param * $urlRouterProvider.otherwise(function ($injector, $location) { - * ... + * return '/a/valid/url'; * }); * }); * * * @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 */