Skip to content

Commit

Permalink
minor #3789 [Reference][Forms] Improvements to the form type (xabbuh)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.3 branch.

Discussion
----------

[Reference][Forms] Improvements to the form type

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

Commits
-------

8a6feb8 fix the order of the options in the table to match their order below
8e7ebf5 add the action option and the method option to the introductionary table, remove doubled include of them
f6a6566 document the default value of the form's compound option
  • Loading branch information
weaverryan committed May 10, 2014
2 parents 72fae25 + 8a6feb8 commit 7288a33
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
10 changes: 4 additions & 6 deletions reference/forms/types/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ The ``form`` type predefines a couple of options that are then available
on all types for which ``form`` is the parent type.

+-----------+--------------------------------------------------------------------+
| Options | - `compound`_ |
| | - `data`_ |
| Options | - `data`_ |
| | - `data_class`_ |
| | - `empty_data`_ |
| | - `compound`_ |
| | - `required`_ |
| | - `label_attr`_ |
| | - `constraints`_ |
Expand All @@ -30,6 +30,8 @@ on all types for which ``form`` is the parent type.
| | - `extra_fields_message`_ |
| | - `post_max_size_message`_ |
| | - `pattern`_ |
| | - `action`_ |
| | - `method`_ |
+-----------+--------------------------------------------------------------------+
| Inherited | - `block_name`_ |
| options | - `disabled`_ |
Expand All @@ -50,10 +52,6 @@ Field Options

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

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

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

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

.. include:: /reference/forms/types/options/compound.rst.inc
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/options/compound.rst.inc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
compound
~~~~~~~~

**type**: ``boolean``
**type**: ``boolean`` **default**: ``true``

This option specifies if a form is compound. This is independent of whether the
form actually has children. A form can be compound but not have any children
Expand Down

0 comments on commit 7288a33

Please sign in to comment.