Add note about the property attribute (Property Accessor) #3124
Conversation
I think we must document the fact that propety is a path which is evaluted by the PropertyAccessor component.
| @@ -96,6 +96,23 @@ This is the property that should be used for displaying the entities | |||
| as text in the HTML element. If left blank, the entity object will be | |||
| cast into a string and so must have a ``__toString()`` method. | |||
|
|
|||
| Note: ``property`` is the property path used to display the option. So you | |||
There was a problem hiding this comment.
Why not using a note-directive here?
There was a problem hiding this comment.
Yep, make it look like this:
.. note::
The ``property`` option is the property path...
And then everything will start indented by 4 spaces
| .. note:: | ||
|
|
||
| The ``property`` option is the property path used to display the option. So you | ||
| can use anything supported by the :doc:`PropertyAccessor component</components/property_access/introduction>` |
There was a problem hiding this comment.
you should move the doc directive to a new line and add a space between component and the opening angle bracket
| can use anything supported by the | ||
| :doc:`PropertyAccessor component </components/property_access/introduction>` | ||
|
|
||
| Usage sample:: |
There was a problem hiding this comment.
Ok then, how about we just tell them what translations looks like here:
For example, if the
translationsproperty is actually an associative array of objects, each with anameproperty, then you could do this::
Then I'm not sure if we need the query_builder option - it may just be distracting.
Thanks for the work on this @raziel057!
There was a problem hiding this comment.
Ping @raziel057 - what do you think about removing the query_builder option and adding the note above?
Thanks!
There was a problem hiding this comment.
Hi, I made the change as requested.
|
Awesome, thanks Thomas! It's definitely a really great note to have in there! |
…r) (raziel057) This PR was submitted for the 2.2 branch but it was merged into the 2.3 branch instead (closes #3124). Discussion ---------- Add note about the property attribute (Property Accessor) I think we must document the fact that propety is a path which is evaluted by the PropertyAccessor component. Commits ------- 46f1b8b Update entity.rst 7496e68 Update entity.rst c097f9b Update entity.rst 7d65fed Update entity.rst 6af779d Add note about the property attribute (Property Accessor)
I think we must document the fact that propety is a path which is evaluted by the PropertyAccessor component.