New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

$locationChangeStart, $locationChangeSuccess events are not documented #1569

Closed
nickretallack opened this Issue Nov 13, 2012 · 9 comments

Comments

Projects
None yet
7 participants
@nickretallack

nickretallack commented Nov 13, 2012

These events are emitted by angular, but they are never mentioned in the documentation: $locationChangeStart, $locationChangeSuccess, $includeContentLoaded, $viewContentLoaded, $routeChangeStart, $routeChangeError

The other events are only mentioned in passing: $routeUpdate, $routeChangeSuccess. It would be nice if events had a place in the documentation.

@pkozlowski-opensource

This comment has been minimized.

Member

pkozlowski-opensource commented Nov 14, 2012

So, had a quick look at the docs and in fact most of the events are documented:

The only ones missing from the doc seem to be the $location events (or at least I can't find docs for them). Changing the title of this issue to better reflect this.

@gotoAndBliss

This comment has been minimized.

gotoAndBliss commented Jan 31, 2013

Also the search does not pick up any of these keywords, neither can Google find them.

@boxed

This comment has been minimized.

boxed commented May 10, 2013

Am I right in understanding that the docs are generated from the comment marked with "@ngdoc" in https://github.com/angular/angular.js/blob/master/src/ng/http.js ?

@wladston

This comment has been minimized.

wladston commented Jun 6, 2013

+1, took me a long time to find that these actually existed.

@btford btford closed this Aug 24, 2013

@btford

This comment has been minimized.

Contributor

btford commented Aug 24, 2013

As part of our effort to clean out old issues, this issue is being automatically closed since it has been inactivite for over two months.

Please try the newest versions of Angular (1.0.8 and 1.2.0-rc.1), and if the issue persists, comment below so we can discuss it.

Thanks!

@nickretallack

This comment has been minimized.

nickretallack commented Aug 24, 2013

What? Don't just close this. Document it. These events are still undocumented in the latest version. http://code.angularjs.org/1.2.0rc1/docs/api/ng.$location

@btford btford reopened this Aug 24, 2013

@btford

This comment has been minimized.

Contributor

btford commented Aug 24, 2013

Would anyone like to submit a PR for this? :)

@Nitrodist

This comment has been minimized.

Contributor

Nitrodist commented Aug 25, 2013

I'll probably get around to doing it. Is the ng.$location page the appropriate place to do it? Is there similar documentation that I can look at so that I know what kinds of things I should explain?

@pkozlowski-opensource

This comment has been minimized.

Member

pkozlowski-opensource commented Aug 25, 2013

@Nitrodist a PR would be awesome. Yes, $location is the proper place. While preparing a PR you can use documentation of the existing routing events as an example:
https://github.com/angular/angular.js/blob/master/src/ngRoute/route.js#L337-L390

olostan added a commit to olostan/angular.js that referenced this issue Oct 22, 2013

docs($location): add documentation of $location's events
Added documentation for $locationChangeStart and $locationChangeSuccess

Closes angular#1569

jamesdaily added a commit to jamesdaily/angular.js that referenced this issue Jan 27, 2014

jamesdaily added a commit to jamesdaily/angular.js that referenced this issue Jan 27, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment