Clarify by_reference use #6923
Closed
Clarify by_reference use #6923
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I'd like to make it clear that `by_reference` must be set to `false` if the developer requires that an entity's setter method be called.
| @@ -5,7 +5,7 @@ by_reference | |||
|
|
|||
| In most cases, if you have a ``name`` field, then you expect ``setName()`` | |||
| to be called on the underlying object. In some cases, however, ``setName()`` | |||
| may *not* be called. Setting ``by_reference`` ensures that the setter is | |||
| may *not* be called. Setting ``by_reference=false`` ensures that the setter is | |||
| called in all cases. | |||
There was a problem hiding this comment.
Actually in this case the setter setName is called in all case. Would be better to make it more explicit too by replacing it by:
In most cases, if you have an ``author`` field, then you expect ``setAuthor()...``
|
Thank you for improving the docs :) Status: needs work |
|
LGTM 👍 Status: reviewed |
|
Thank you @jxmallett. |
xabbuh
added a commit
that referenced
this pull request
Sep 21, 2016
This PR was submitted for the 3.1 branch but it was merged into the 2.7 branch instead (closes #6923). Discussion ---------- Clarify by_reference use I'd like to make it clear that `by_reference` must be set to `false` if the developer requires that an entity's setter method be called. Commits ------- 6675692 Clarify by_reference use
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'd like to make it clear that
by_referencemust be set tofalseif the developer requires that an entity's setter method be called.