Documenting missing form options

[wouterj]

The form type reference is not yet fully updated. It should be updated in the 2.3 branch.

Documenting new options

Most of the missing options are already documented. You should check in the reference/forms/types/options/ directory to find if the option is already documented and if the description is correct for this type. If it is, you should add an include statement in the type reference article:

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

If the description is not correct for this type, you need to document it in the type reference article, not in the .rst.inc file, since it's used in multiple places where the current description is correct.

error_bubbling
~~~~~~~~~~~~~~
**type**: ``boolean`` **default**: ``false``

Some description and usage of the type.

If there is no documentation about the option and it is used in other types, you should create a new file in the reference/forms/types/options/ directory and include it in the relevant types.

If you are documenting an option that's new in a specific version, you should add a versionadded directive above it. This should only be done for types introduced in 2.2 or newer, not for 2.1:

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

with_minutes
~~~~~~~~~~~~
**type**: ``boolean`` **default**: ``true``

...

Removing/renaming an option

When an option should be removed or renamed, you should remove/rename the file from
/reference/forms/types/options and check all form types to remove/rename the
include statements, references and other occurences of that option.

The missing options in 2.3

datetime

• [x]
  format (new in 2.1)

form

• empty_data (new in 2.1)
• max_length
• pattern
• by_reference
• error_bubbling
• auto_initialize (new in 2.3)
• inherit_data (new in 2.3)
• method (new in 2.3)
• action (new in 2.3)
• error_mapping
• invalid_message
• invalid_message_parameters
• extra_fields_message
• post_max_size_message

radio

• Parent type changed from field to form in 2.1.
• value option should be removed from this type

time

• with_minutes (new in 2.2)

[wouterj]

Only one option left to do: auto_initialize of the Form type. Thank you @bicpi, @nykopol and @xabbuh for your great work on this issue!

[xabbuh]

Awesome! I'll add auto_initialize in #3611.

[wouterj]

Thanks to @xabbuh, the last one if fixed too. That means it's the first time ever that the form options reference is complete! 🍰

Now, let's move onto the other reference articles :P

[bicpi]

😁

[wouterj]

For people interested in history, this is how it looked like when it was created: feee616#diff-d630590f6ace919528a3829793c6e30fR1

[xabbuh]

👍