docs($location): describe your change... #14544
Conversation
docs for return of path() inaccurately describe the function’s return when a value is passed in.
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed, please reply here (e.g.
|
1 similar comment
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed, please reply here (e.g.
|
|
I signed it! |
|
CLAs look good, thanks! |
1 similar comment
|
CLAs look good, thanks! |
| @@ -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 | |||
There was a problem hiding this comment.
I don't think objects are supported per se, they just work because we call toString on path, which was added here: #7054. I think we shouldn't have built in handling for intergers, as the docs clearly say the path must be a string.
There was a problem hiding this comment.
Disregard my last comment, I was in the wrong line.
docs for return of path() inaccurately describe the function’s return when a value is passed in. Closes #14544
docs for return of path() inaccurately describe the function’s return when a value is passed in. Closes #14544
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
docs update
What is the current behavior? (You can also link to an open issue here)
inaccurate docs
What is the new behavior (if this is a feature change)?
correct docs
Does this PR introduce a breaking change?
no
Please check if the PR fulfills these requirements
Other information:
docs for return of path() inaccurately describe the function’s return when a value is passed in.