Skip to content

Conversation

mhenrixon
Copy link
Contributor

Removed the on load stuff since there is no autoloading in AMS anymore.

Removed the on load stuff since there is no autoloading in AMS anymore.
@coveralls
Copy link

Coverage Status

Coverage increased (+0.05%) when pulling dcc4f27 on mhenrixon:patch-1 into 74d19e7 on rails-api:master.

spastorino added a commit that referenced this pull request Oct 26, 2013
Fix root initializer documentation
@spastorino spastorino merged commit ebe3afe into rails-api:master Oct 26, 2013
@arthurnn
Copy link
Contributor

I am concern about changing the docs right now, as master is not released yet. Could that be a problem? Could people get confused and try to use the instructions from the README using version 0.8 ?
@spastorino thoughts?

@spastorino
Copy link
Contributor

Hmmm yes, you're right. Maybe we can add a README-0.8.md file and a comment in CAPS SAYING IF YOU'RE USING 0.8 GO HERE, THIS IS THE README OF MASTER, NEXT 0.9. Or could be even the other way around, I mean let's add README-master.md and point to that file from the 0.8 version. Whatever :)

@mhenrixon
Copy link
Contributor Author

I've had this problem before and I believe that http://savonrb.com/ handles it very nicely but it takes some more work of course. Not sure the changes between versions will ever be major enough to call for completely separate docs?

Otherwise a version number note might be a good idea. Also!!! I would strongly recommend a gem specification .post_install_message about removing the autoload stuff in the initializer just to make sure that when the next version is released and people update they get notified they also need to change their documentation.

I did the post_install_message thing on https://github.com/inossidabile/wash_out for a breaking change between versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants