Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
Add note about the property attribute (Property Accessor)#3124
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Why not using anote-directive here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
you should move thedoc 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Ok then, how about we just tell them whattranslations 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 thequery_builder option - it may just be distracting.
Thanks for the work on this@raziel057!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Ping@raziel057 - what do you think about removing thequery_builder option and adding the note above?
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.rst7496e68 Update entity.rstc097f9b Update entity.rst7d65fed Update entity.rst6af779d 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.