Description
The Form Type Reference has some missing options.
How to document it
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:
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 articles.
The Missing Options in 2.0
The options are all linked to the place where they are defined in the core code. However, search in the class to find some usage and other important information about the option you're documenting.
DateTime
Field
-
data_class
-
read_only
-
max_length
-
pattern
-
by_reference
-
error_bubbling
-
error_mapping
-
label
-
invalid_message
-
invalid_message_parameters
- the
disabled
option should get removed
Form
Integer
-
precision
(the docs already exists in the Number type, just create a
precision.rst.inc
and include it in both)
Time