From a832c6067f8ac42ceb827f6b6515d5e97e84f0ea Mon Sep 17 00:00:00 2001 From: FGasper Date: Fri, 29 Apr 2016 14:40:11 -0500 Subject: [PATCH] docs($location): describe your change... MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit docs for return of path() inaccurately describe the function’s return when a value is passed in. --- src/ng/location.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ng/location.js b/src/ng/location.js index 63c3eed97fb9..7a64aefdf193 100644 --- a/src/ng/location.js +++ b/src/ng/location.js @@ -482,7 +482,7 @@ var locationPrototype = { * ``` * * @param {(string|number)=} path New path - * @return {string} path + * @return {(string|object)} path if called with no parameters, or `$location` if called with a parameter */ path: locationGetterSetter('$$path', function(path) { path = path !== null ? path.toString() : '';