From 0bd2efb99456f4e54a3ac4f736b5fb144e8d9858 Mon Sep 17 00:00:00 2001
From: FGasper <FGasper@users.noreply.github.com>
Date: Fri, 6 May 2016 08:17:21 -0500
Subject: [PATCH] docs($location): clarify return value for path method
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.

Closes #14544
---
 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 63c3eed97..7a64aefdf 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() : '';