Update associations.rb API documentation [ci skip] #33857
Conversation
Addresses issue #33599
|
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. |
guides/source/association_basics.md
Outdated
| @@ -1184,7 +1184,7 @@ If the associated object has already been retrieved from the database for this o | |||
|
|
|||
| ##### `association=(associate)` | |||
|
|
|||
| The `association=` method assigns an associated object to this object. Behind the scenes, this means extracting the primary key from this object and setting the associated object's foreign key to the same value. | |||
| The `association=` method assigns an associated object to this object. Behind the scenes, this means extracting the primary key from this object and setting the associated object's foreign key to the same value. No modification or deletion of existing records takes place. | |||
There was a problem hiding this comment.
I think we should add it to "Methods Added by belongs_to" section
There was a problem hiding this comment.
Also, It might be better to add to the api docs to belongs_to (per #33599)
There was a problem hiding this comment.
Yes, we want to add to the API docs. The guides only give an overview. Details of how things works are in the method documentation.
There was a problem hiding this comment.
Thanks for your feedback and clarification, I've updated the PR accordingly
Additional detail for documentation of `belongs_to` `association=(associate)`
Reverts misplaced documentation comment
LucasBrandt
changed the title
|
@LucasBrandt Could you also please squash your commits into one? |
|
Thanks for the feedback again @bogdanvlviv . I created the PR entirely using GitHub on the web, and as a result I'm not sure how to squash the commits. Is it possible for the commits to be squashed on merge (if the changes in the PR are appropriate)? Alternatively, I could close this PR and open another with a single commit. |
|
Squash merged. Thank you for your contribution! |
As discussed in issue #33599 , the documentation for
association=(association)can be improved by clarifying that no deletions or modifications are performed on existing records.