From 7e75591885deca4f2b284f6420d52c5054c0b0d3 Mon Sep 17 00:00:00 2001 From: Julian Mallett Date: Mon, 29 Aug 2016 09:48:39 +1000 Subject: [PATCH 1/2] 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. --- reference/forms/types/options/by_reference.rst.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/forms/types/options/by_reference.rst.inc b/reference/forms/types/options/by_reference.rst.inc index e2552817470..eff92cb9e8e 100644 --- a/reference/forms/types/options/by_reference.rst.inc +++ b/reference/forms/types/options/by_reference.rst.inc @@ -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. To explain this further, here's a simple example:: From c38ed769f31423a938374146b9168e9b980ad684 Mon Sep 17 00:00:00 2001 From: Julian Mallett Date: Tue, 30 Aug 2016 13:50:45 +1000 Subject: [PATCH 2/2] Made changes suggested by @HeahDude --- reference/forms/types/options/by_reference.rst.inc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/forms/types/options/by_reference.rst.inc b/reference/forms/types/options/by_reference.rst.inc index eff92cb9e8e..c4839b74ab0 100644 --- a/reference/forms/types/options/by_reference.rst.inc +++ b/reference/forms/types/options/by_reference.rst.inc @@ -3,9 +3,9 @@ by_reference **type**: ``boolean`` **default**: ``true`` -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=false`` ensures that the setter is +In most cases, if you have an ``author`` field, then you expect ``setAuthor()`` +to be called on the underlying object. In some cases, however, ``setAuthor()`` +may *not* be called. Setting ``by_reference`` to ``false`` ensures that the setter is called in all cases. To explain this further, here's a simple example::