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

Better route config docs #1041

Merged
merged 4 commits into from Aug 2, 2016

Conversation

Projects
None yet
1 participant
@marcoow
Copy link
Member

marcoow commented Aug 2, 2016

This improves the docs and deprecations for the routes that ESA transitions to in different scenarios.

@marcoow marcoow added this to the 1.2 milestone Aug 2, 2016

@marcoow marcoow self-assigned this Aug 2, 2016

@@ -47,7 +47,7 @@ export default {
route is not authenticated.
@property authenticationRoute
@deprecated 'deprecated in favor of overriding the authenticationRoute method on the authenticatedRouteMixin'
@deprecated AuthenticatedRouteMixin/authenticationRoute:property

This comment has been minimized.

@marcoow

marcoow Aug 2, 2016

Member

YUIDoc doesn't allow crosslinks or any formatting in the deprecation message. So instead of providing an actual text here we simply only provide the reference to the things that this elements has been deprecated in favor of so that we can link to that in the docs.

@marcoow marcoow force-pushed the better-route-config-docs branch from 940d0ad to de99825 Aug 2, 2016

@marcoow marcoow merged commit 31462f1 into master Aug 2, 2016

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@marcoow marcoow deleted the better-route-config-docs branch Aug 2, 2016

bakerac4 added a commit to bakerac4/ember-simple-auth that referenced this pull request Sep 8, 2016

Better route config docs (simplabs#1041)
* render better deprecations in docs

* better deprecation text

* better docs for transition route properties

* don't show deprecated config setting in README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment