Skip to content

Added caution block under delete_empty to warn the developer when he try to activate delete_empty for collections of compound forms #7767

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.

Sign up for GitHub

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 5 commits into from
Jul 21, 2017
Merged

Added caution block under delete_empty to warn the developer when he try to activate delete_empty for collections of compound forms #7767

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9e375c
Added caution block under delete_empty to warn the developer when he …
murilolobato Apr 7, 2017
ca04555
Improved format of message and added missing information.
murilolobato Apr 8, 2017
de25ede
Minor reword
javiereguiluz Apr 8, 2017
52c0a94
Minor fix
javiereguiluz Apr 8, 2017
ce30e47
Applied reviewer suggestion
murilolobato Apr 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions reference/forms/types/collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,15 @@ form you have to set this option to true. However, existing collection entries
will only be deleted if you have the allow_delete_ option enabled. Otherwise
the empty values will be kept.

.. caution::

The ``delete_empty`` option only removes items when the normalized value is
Copy link
Member

Choose a reason for hiding this comment

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

there are two spaces before "value"

``null``. If your `type`_ is a compound form type, you must either set the
Copy link
Contributor

Choose a reason for hiding this comment

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

Then we should be even more explicit it here, before 2.8 options may be confusing, let's use:

If the nested `type`_ is a compound form type

WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

👍 sounds good to me

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually type must be renamed entry_type in 2.8 too.

``required`` option to ``false`` or set the ``empty_data`` option to ``null``.
Both of these options can be set inside `options`_. See
:ref:`form's empty_data option <reference-form-option-empty-data>` to learn
why this is necessary.

options
~~~~~~~

Expand Down
2 changes: 2 additions & 0 deletions reference/forms/types/form.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ option on the form.

.. include:: /reference/forms/types/options/data_class.rst.inc

.. _reference-form-option-empty-data:

.. include:: /reference/forms/types/options/empty_data.rst.inc
:end-before: DEFAULT_PLACEHOLDER

Expand Down