8000 add notes on collection and entity field types by joelclermont · Pull Request #2428 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

add notes on collection and entity field types #2428

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2013

Conversation

joelclermont
Copy link
Contributor
Q A
Doc fix? yes
New docs? yes
Applies to all
Fixed tickets #1566

I added notes at the top of the collection and entity field types, directing the user to more specific documentation (and the cookbook article) if they are working with collections of Doctrine entities. Hopefully, this will point people in the right direction.

If you are working with a collection of Doctrine entities, it will be helpful
to read the documention for the :doc:`/reference/forms/types/collection`
as well. In addition, there is a complete example in the cookbook article
:doc:`/cookbook/form/form_collections`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's safe to move this under the multiple option, since you'll definitely need multiple => true for this to be an issue.

@weaverryan
Copy link
Member

I like it! The only improvement that we can't make yet is to link to the addXxx and removeXxx docs that'll be added for #1057. Obviously, we don't need to worry about that now.

@joelclermont
Copy link
Contributor Author

Great feedback. Changes made. Removing WIP from title.

.. note::

If you are working with a collection of Doctrine entities, pay special
attention to the ``allow_add``, ``allow_delete`` and ``by_reference`` options.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to use reference links here:

attention to the `allow_add`_, `allow_delete`_ and `by_reference`_ options.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. PR has been updated accordingly.

@wouterj
Copy link
Member
wouterj commented Apr 2, 2013

👍

weaverryan added a commit that referenced this pull request Apr 4, 2013
add notes on collection and entity field types
@weaverryan weaverryan merged commit 8e196bf into symfony:2.0 Apr 4, 2013
@weaverryan
Copy link
Member

big 👍

Thanks Joel!

@joelclermont joelclermont deleted the issue_1566 branch April 4, 2013 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0