docs($location): clarify return value for path method

docs for return of path() inaccurately describe the function’s return when a value is passed in.

Closes #14544
This commit is contained in:
FGasper
2016-05-06 08:17:21 -05:00
committed by Martin Staffa
parent 5222703444
commit 1c47abc462
+1 -1
View File
@@ -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() : '';