Skip to content

Commit

Permalink
minor #3416 add empty_data option where required option is used (xabbuh)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.3 branch.

Discussion
----------

add empty_data option where required option is used

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Commits
-------

d9c6a85 add empty_data option where required option is used
  • Loading branch information
weaverryan committed Jan 9, 2014
2 parents 26b8146 + d9c6a85 commit 1e0311e
Show file tree
Hide file tree
Showing 21 changed files with 78 additions and 19 deletions.
5 changes: 4 additions & 1 deletion reference/forms/types/checkbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ if the box is unchecked, the value will be set to false.
| Options | - `value`_ |
+-------------+------------------------------------------------------------------------+
| Inherited | - `data`_ |
| options | - `required`_ |
| options | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -60,6 +61,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ forms, which is useful when creating forms that expose one-to-many relationships
| | - `prototype_name`_ |
+-------------+-----------------------------------------------------------------------------+
| Inherited | - `label`_ |
| | - `label_attr`_ |
| options | - `error_bubbling`_ |
| options | - `label_attr`_ |
| | - `error_bubbling`_ |
| | - `error_mapping`_ |
| | - `by_reference`_ |
| | - `empty_data`_ |
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/country.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ you should just use the ``choice`` type directly.
| | - `empty_value`_ |
| | - `error_bubbling`_ |
| | - `error_mapping`_ |
| | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
Expand Down Expand Up @@ -74,6 +75,8 @@ These options inherit from the :doc:`choice </reference/forms/types/choice>` typ

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/currency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ should just use the ``choice`` type directly.
| | - `preferred_choices`_ |
| | - `empty_value`_ |
| | - `error_bubbling`_ |
| | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
Expand Down Expand Up @@ -64,6 +65,8 @@ These options inherit from the :doc:`choice</reference/forms/types/choice>` type

These options inherit from the :doc:`form</reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
5 changes: 4 additions & 1 deletion reference/forms/types/email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ The ``email`` field is a text field that is rendered using the HTML5
| Rendered as | ``input`` ``email`` field (a text box) |
+-------------+---------------------------------------------------------------------+
| Inherited | - `max_length`_ |
| options | - `required`_ |
| options | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `data`_ |
Expand All @@ -34,6 +35,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/entity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ objects from the database.
| options | - `expanded`_ |
| | - `preferred_choices`_ |
| | - `empty_value`_ |
| | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
Expand Down Expand Up @@ -196,6 +197,8 @@ These options inherit from the :doc:`choice </reference/forms/types/choice>` typ

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ The ``file`` type represents a file input in your form.
+-------------+---------------------------------------------------------------------+
| Rendered as | ``input`` ``file`` field |
+-------------+---------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `empty_data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `read_only`_ |
| | - `disabled`_ |
Expand Down Expand Up @@ -82,6 +83,8 @@ Inherited options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
2 changes: 2 additions & 0 deletions reference/forms/types/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ on all fields.

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

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/integer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6
| | - `precision`_ |
| | - `grouping`_ |
+-------------+-----------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `empty_data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `data`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -69,6 +70,8 @@ Inherited options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/language.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ you should just use the ``choice`` type directly.
| | - `empty_value`_ |
| | - `error_bubbling`_ |
| | - `error_mapping`_ |
| | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
Expand Down Expand Up @@ -75,6 +76,8 @@ These options inherit from the :doc:`choice </reference/forms/types/choice>` typ

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/locale.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ you should just use the ``choice`` type directly.
| | - `empty_value`_ |
| | - `error_bubbling`_ |
| | - `error_mapping`_ |
| | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
Expand Down Expand Up @@ -77,6 +78,8 @@ These options inherit from the :doc:`choice </reference/forms/types/choice>` typ

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/money.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ how the input and output of the data is handled.
| | - `precision`_ |
| | - `grouping`_ |
+-------------+---------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `empty_data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `data`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -87,6 +88,8 @@ Inherited Options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/number.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ you want to use for your number.
| | - `precision`_ |
| | - `grouping`_ |
+-------------+----------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `empty_data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `data`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -77,6 +78,8 @@ Inherited Options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
5 changes: 4 additions & 1 deletion reference/forms/types/password.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ The ``password`` field renders an input password text box.
| Options | - `always_empty`_ |
+-------------+------------------------------------------------------------------------+
| Inherited | - `max_length`_ |
| options | - `required`_ |
| options | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `trim`_ |
Expand Down Expand Up @@ -51,6 +52,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/percent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ This field adds a percentage sign "``%``" after the input box.
| Options | - `type`_ |
| | - `precision`_ |
+-------------+-----------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `empty_data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `data`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -71,6 +72,8 @@ Inherited Options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
5 changes: 4 additions & 1 deletion reference/forms/types/radio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ If you want to have a Boolean field, use :doc:`checkbox </reference/forms/types/
| Options | - `value`_ |
+-------------+---------------------------------------------------------------------+
| Inherited | - `data`_ |
| options | - `required`_ |
| options | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -54,6 +55,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
5 changes: 4 additions & 1 deletion reference/forms/types/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Read about the input search field at `DiveIntoHTML5.info`_
| Rendered as | ``input search`` field |
+-------------+----------------------------------------------------------------------+
| Inherited | - `max_length`_ |
| options | - `required`_ |
| options | - `empty_data`_ |
| | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `trim`_ |
Expand All @@ -35,6 +36,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

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

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

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

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
Loading

0 comments on commit 1e0311e

Please sign in to comment.