Skip to content
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

Update Rails Guides about :autosave option #30548

Merged
merged 1 commit into from
Sep 20, 2017

Conversation

chumakoff
Copy link
Contributor

@chumakoff chumakoff commented Sep 8, 2017

Call attention to the fact, that If the :autosave option is not set (neither true nor false), it is not the same as false: only new loaded members are saved.

According to this

# Note that <tt>autosave: false</tt> is not same as not declaring <tt>:autosave</tt>.

@rails-bot
Copy link

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @eileencodes (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.

Copy link
Member

@eileencodes eileencodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @chumakoff thanks for the PR!

I think this change is confusing for readers. I think it's not clear what is not the same as false. What do you think about combining the original docs you linked to like this:

If you set the :autosave option to true, Rails will save any loaded members and destroy members that are marked for destruction whenever you save the parent object. Setting :autosave to false is not the same as not setting the :autosave option. When the :autosave option is not present then new association records are saved but the updated association records are not saved.

@chumakoff
Copy link
Contributor Author

chumakoff commented Sep 9, 2017

@eileencodes Hi! I agree with you. But I have one more thing to suggest. In the guide there is almost everywere "associated objects"wording. Sometimes it is "association members". In this paragraph it is "members" in the first sentence (I think it's not very clear what members), and "association records" further. So, let's use the same wording for uniformity and definiteness.

If you set the :autosave option to true, Rails will save any loaded association members and destroy members that are marked for destruction whenever you save the parent object. Setting :autosave to false is not the same as not setting the :autosave option. If the :autosave option is not present, then new associated objects will be saved, but updated associated objects will not be saved.

What do you think?

@eileencodes
Copy link
Member

@chumakoff sounds good. Please update the PR and squash your commits. Thanks for working on this!.

@chumakoff
Copy link
Contributor Author

@eileencodes Done. Thank you for your cooperation! )

@eileencodes eileencodes merged commit aa0c877 into rails:master Sep 20, 2017
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.

None yet

3 participants