Documenting all missing options #2362

Closed
wouterj opened this Issue Mar 26, 2013 · 13 comments

Projects

None yet

4 participants

@wouterj
Member
wouterj commented Mar 26, 2013

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

Form

Integer

  • precision
    (the docs already exists in the Number type, just create a
    precision.rst.inc and include it in both)

Time

@xabbuh
Member
xabbuh commented Nov 4, 2013

Meanwhile (7e06f9f), the following options have been documented:

  • DateTime
    • empty_value
  • Integer
    • precision
  • Number
    • precision
  • Time
    • empty_value
@wouterj
Member
wouterj commented Nov 4, 2013

thanks @xabbuh, updated the PR

@xabbuh
Member
xabbuh commented Nov 4, 2013

What do we do with the Field options as it is not part of Symfony since 2.1?

@stof
Member
stof commented Nov 4, 2013

@xabbuh they are part of Symfony, but in the form type

@xabbuh
Member
xabbuh commented Nov 4, 2013

I know. I think my question was not clear enough. I'm wondering if this list also applies to the FormType? Specifically, why should the disabled option be removed?

@wouterj
Member
wouterj commented Nov 4, 2013

@xabbuh disabled was added in 2.1, not 2.0.

This list does not fully apply to 2.1.

@xabbuh
Member
xabbuh commented Nov 4, 2013

So that's not a problem anymore.

I'll walk through the list one by one and will provide an updated list.

@stof
Member
stof commented Nov 4, 2013

@WouterJ for 2.0, disabled was the same option than read_only in 2.1+

@xabbuh
Member
xabbuh commented Nov 4, 2013

The following options need to be documented:

  • data_class
  • empty_data
  • max_length
  • pattern
  • by_reference
  • error_bubbling
  • label
  • label_attr
  • compound
@dorians
dorians commented Dec 14, 2013

I think some options are already documented. So it's an updated list:

  • data_class (#3334)
  • empty_data
  • pattern
  • by_reference
  • label_attr (#3337)
  • compound (#3336)
@dorians dorians added a commit to dorians/symfony-docs that referenced this issue Dec 14, 2013
@dorians dorians [#2362] Documentation for label_attr option in Form Compontent 4159c46
@xabbuh
Member
xabbuh commented Dec 15, 2013

@WouterJ can you update the list in the description (maybe adding references to the pull requests for each option too)?

@dorians dorians added a commit to dorians/symfony-docs that referenced this issue Dec 15, 2013
@dorians dorians [#2362] Documentation for label_attr option in Form Compontent 9068288
@wouterj
Member
wouterj commented Dec 15, 2013

@xabbuh I've rechecked everything and updated my form type tree: https://gist.github.com/WouterJ/5246728 I'll update this issue this week

@weaverryan weaverryan added a commit that referenced this issue Dec 26, 2013
@dpcat237 dpcat237 Create compound.rst.inc #2362
Create description for "compound" option.
dcde98b
@weaverryan weaverryan added a commit that referenced this issue Jan 1, 2014
@dpcat237 dpcat237 Create data_class.rst.inc #2362
Create data_class documentation.
704302c
@wouterj
Member
wouterj commented Jan 3, 2014

closing in favor of #3410

@wouterj wouterj closed this Jan 3, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment