Skip to content

Commit

Permalink
minor #3790 [Reference][Forms] move versionadded directives for form …
Browse files Browse the repository at this point in the history
…options directly below the option's headline (xabbuh)

This PR was merged into the 2.3 branch.

Discussion
----------

[Reference][Forms] move versionadded directives for form options directly below the option's headline

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

When you link directly to a form type option (for example, http://symfony.com/doc/current/reference/forms/types/form.html#action), the ``versionadded`` directive is rendered outside the user's view port which might confuse people. Thus, @wouterj and me decided to place ``versionadded`` directives for form type options directly below the option's headline (above the ``type`` line).

Commits
-------

72c30c2 move versionadded directives for form options directly below the option's headline
  • Loading branch information
weaverryan committed May 10, 2014
2 parents b4d4ac3 + 72c30c2 commit 72fae25
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions reference/forms/types/options/action.rst.inc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. versionadded:: 2.3
The ``action`` option was introduced in Symfony 2.3.

action
~~~~~~

.. versionadded:: 2.3
The ``action`` option was introduced in Symfony 2.3.

**type**: ``string`` **default**: empty string

This option specifies where to send the form's data on submission (usually a
Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/options/empty_value.rst.inc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
empty_value
~~~~~~~~~~~

**type**: ``string`` or ``Boolean``

.. versionadded:: 2.3
Since Symfony 2.3, empty values are also supported if the ``expanded``
option is set to true.

**type**: ``string`` or ``Boolean``

This option determines whether or not a special "empty" option (e.g. "Choose an option")
will appear at the top of a select widget. This option only applies if the
``multiple`` option is set to false.
Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/options/error_mapping.rst.inc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
error_mapping
~~~~~~~~~~~~~

**type**: ``array`` **default**: ``empty``

.. versionadded:: 2.1
The ``error_mapping`` option was introduced in Symfony 2.1.

**type**: ``array`` **default**: ``empty``

This option allows you to modify the target of a validation error.

Imagine you have a custom method named ``matchingCityAndZipCode`` that validates
Expand Down
6 changes: 3 additions & 3 deletions reference/forms/types/options/method.rst.inc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. versionadded:: 2.3
The ``method`` option was introduced in Symfony 2.3.

method
~~~~~~

.. versionadded:: 2.3
The ``method`` option was introduced in Symfony 2.3.

**type**: ``string`` **default**: ``POST``

This option specifies the HTTP method used to submit the form's data. Its
Expand Down
6 changes: 3 additions & 3 deletions reference/forms/types/options/with_minutes.rst.inc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. versionadded:: 2.2
The ``with_minutes`` option was introduced in Symfony 2.2.

with_minutes
~~~~~~~~~~~~

.. versionadded:: 2.2
The ``with_minutes`` option was introduced in Symfony 2.2.

**type**: ``Boolean`` **default**: ``true``

Whether or not to include minutes in the input. This will result in an additional
Expand Down

0 comments on commit 72fae25

Please sign in to comment.