-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documented the new label_format option #4412
Documented the new label_format option #4412
Conversation
javiereguiluz
commented
Nov 2, 2014
Q | A |
---|---|
Doc fix? | no |
New docs? | yes |
Applies to | 2.6+ |
Fixed tickets | #4286 |
@javiereguiluz The new file is missing the |
.. versionadded:: 2.6 | ||
The ``label_format`` option was introduced in Symfony 2.6 | ||
|
||
**type**: ``string`` **default**: The label is "humanized" version of the field name |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[...] is the "humanized" [...]
@@ -1 +1 @@ | |||
Subproject commit 52f7bd2216cc22ef52494f346c5643bb2a74513f | |||
Subproject commit e58edd22d16cb247267025d557410dcbfa5fa959 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it intended to change the sphinx-php extension version ?
|
||
Sets the format applied to generate the ``<label>`` element, which will be used when | ||
rendering the label for the field. This option supports two placeholders called | ||
``%name%`` and ``%id%``:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you please add a short explaination for name and id? (name = name of the field, id = name of each parent field + name of the field).
ping @javiereguiluz |
.. versionadded:: 2.6 | ||
The ``label_format`` option was introduced in Symfony 2.6 | ||
|
||
**type**: ``string`` **default**: The label is the "humanized" version of the field name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is the default value? we should provide this info?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the default value of the option is null
, which will then trigger the generation of the label based on the form name
Maybe there should be a note that this feature is actually implemented in the template and that it won't work if your form theme does not support it? |
this is a good idea indeed. People using a custom type should be aware they might need to update it. |
ping @javiereguiluz |
Hi @javiereguiluz! Do you maybe have some time to update this, or should I put it on the list for the sprint day? |
@wouterj sadly I'm not motivated to finish this PR, so please put it on the list. Thanks! |
Closing in favor of #5642 |
This PR was merged into the 2.7 branch. Discussion ---------- Documented label_format option | Q | A | --- | --- | Doc fix? | no | New docs? | yes (symfony/symfony#12050) | Applies to | 2.6+ | Fixed tickets | #4286 @javiereguiluz abandoned #4412, so I continued #4489. I welcome any improvements, as I'm not 100% sure this is well documented now. Commits ------- ac0fdbc Documented label_format option