-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
Clarify autoload_paths and eager_load in guides per current usage. #31755
Clarify autoload_paths and eager_load in guides per current usage. #31755
Conversation
Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @sgrif (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review. Please see the contribution instructions for more information. |
I edited the PR to be a lot more succinct and clear. The reasoning (which I removed) I put here: I agree with #27268 (which this addresses) that the guide on autoloading is a bit out of date with regard to autoload_paths and eager_load. I've run into this issue before (typically in upgrade / cross-compatibility situations) but not regularly enough to keep it in mind. Each time I've had to piece together how autoloading works. I've pieced it together (again) from:
So I've tried to document for others and my future self how things actually work with recommendations. |
``` | ||
How files are autoloaded depends on `eager_load` and `cache_classes` config settings which typically vary in development, production, and test modes: | ||
|
||
* In **development**, you want quicker startup with incremental loading of application code. So `eager_load` should be set to `false`, and rails will autoload files as needed (see [Autoloading Algorithms](#autoloading-algorithms) below) -- and then reload them when they change (see [Constant Reloading](#constant-reloading) below). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should "rails" be in capital here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes good catch I think you're right -- Rails is always capitalized in the guides (except for filenames / command lines obvs). I didn't spot that before. I'll make a new PR to address that (and any other comments)
correction to rails#31755 as per rails#31755 (comment)
Update the guide on autoloading (which is out of date with current practice and code) to include autoload_paths, eager_load_paths and eager_load in production.