Documenting overriden options #2361

wouterj · 2013-03-26T16:19:31Z

Some form types override their parent options. For instance, the Language type is a child of the Choice type with the choices (in default) set to all languages.

How to document it

These options should get documented under a new section ('Overriden options') in each type in the reference. They should look the same as all other options in this reference. You should link to them in a new table row in the table on top of each reference article.

For instance, the Language type should look like:

+------------+------------+
| ...        | ...        |
+------------+------------+
| Overriden  | - `years`_ |
| options    |            |
+------------+------------+
| ...        | ...        |
+------------+------------+

Overriden Options
-----------------

years
~~~~~

**type**: ``array`` **default**: 120 years ago to the current year

List of years available to the year field type. This option is only relevant
when the ``widget`` option is set to ``choice``.

Inherit Options
---------------

...

Overriden options

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.

Most of these options are already documented in the article, but should only be moved.

Birthday