8000 minor #10511 [FormType] Add help_attr documentation (mpiot) · symfony/symfony-docs@da5aa3b · GitHub
[go: up one dir, main page]
Skip to content

Commit da5aa3b

Browse files
javiereguiluzjaviereguiluz
committed
minor #10511 [FormType] Add help_attr documentation (mpiot)
This PR was squashed before being merged into the master branch (closes #10511). Discussion ---------- [FormType] Add help_attr documentation Add documentation about the new feature symfony/symfony#27043 Commits ------- f6162bc [FormType] Add help_attr documentation
2 parents d3c31d7 + f6162bc commit da5aa3b

32 files changed

+118
-0
lines changed

‎reference/forms/types/birthday.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ option defaults to 120 years ago to the current year.
3939
| | - `data`_ |
4040
| | - `disabled`_ |
4141
| | - `help`_ |
42+
| | - `help_attr`_ |
4243
| | - `inherit_data`_ |
4344
| | - `invalid_message`_ |
4445
| | - `invalid_message_parameters`_ |
@@ -111,6 +112,8 @@ These options inherit from the :doc:`FormType </reference/forms/types/form>`:
111112

112113
.. include:: /reference/forms/types/options/help.rst.inc
113114

115+
.. include:: /reference/forms/types/options/help_attr.rst.inc
116+
114117
.. include:: /reference/forms/types/options/inherit_data.rst.inc
115118

116119
.. include:: /reference/forms/types/options/invalid_message.rst.inc

‎reference/forms/types/checkbox.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ if you want to handle submitted values like "0" or "false").
2525
| | - `error_bubbling`_ |
2626
| | - `error_mapping`_ |
2727
| | - `help`_ |
28+
| | - `help_attr`_ |
2829
| | - `label`_ |
2930
| | - `label_attr`_ |
3031
| | - `label_format`_ |
@@ -83,6 +84,8 @@ These options inherit from the :doc:`FormType </reference/forms/types/form>`:
8384

8485
.. include:: /reference/forms/types/options/help.rst.inc
8586

87+
.. include:: /reference/forms/types/options/help_attr.rst.inc
88+
8689
.. include:: /reference/forms/types/options/label.rst.inc
8790

8891
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/choice.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ To use this field, you must specify *either* ``choices`` or ``choice_loader`` op
3636
| | - `disabled`_ |
3737
| | - `error_mapping`_ |
3838
| | - `help`_ |
39+
| | - `help_attr`_ |
3940
| | - `inherit_data`_ |
4041
| | - `label`_ |
4142
| | - `label_attr`_ |
@@ -270,6 +271,8 @@ These options inherit from the :doc:`FormType </reference/forms/types/form>`:
270271

271272
.. include:: /reference/forms/types/options/help.rst.inc
272273

274+
.. include:: /reference/forms/types/options/help_attr.rst.inc
275+
273276
.. include:: /reference/forms/types/options/inherit_data.rst.inc
274277

275278
.. include:: /reference/forms/types/options/label.rst.inc

‎reference/forms/types/collection.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ photos).
2828
| | - `error_bubbling`_ |
2929
| | - `error_mapping`_ |
3030
| | - `help`_ |
31+
| | - `help_attr`_ |
3132
| | - `label`_ |
3233
| | - `label_attr`_ |
3334
| | - `label_format`_ |
@@ -422,6 +423,8 @@ error_bubbling
422423

423424
.. include:: /reference/forms/types/options/help.rst.inc
424425

426+
.. include:: /reference/forms/types/options/help_attr.rst.inc
427+
425428
.. include:: /reference/forms/types/options/label.rst.inc
426429

427430
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/color.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ element.
2323
| | - `error_bubbling`_ |
2424
| | - `error_mapping`_ |
2525
| | - `help`_ |
26+
| | - `help_attr`_ |
2627
| | - `label`_ |
2728
| | - `label_attr`_ |
2829
| | - `label_format`_ |
@@ -58,6 +59,8 @@ The default value is ``''`` (the empty string).
5859

5960
.. include:: /reference/forms/types/options/help.rst.inc
6061

62+
.. include:: /reference/forms/types/options/help_attr.rst.inc
63+
6164
.. include:: /reference/forms/types/options/label.rst.inc
6265

6366
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/country.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ the option manually, but then you should just use the ``ChoiceType`` directly.
4242
| | - `disabled`_ |
4343
| | - `empty_data`_ |
4444
| | - `help`_ |
45+
| | - `help_attr`_ |
4546
| | - `label`_ |
4647
| | - `label_attr`_ |
4748
| | - `label_format`_ |
@@ -113,6 +114,8 @@ The actual default value of this option depends on other field options:
113114

114115
.. include:: /reference/forms/types/options/help.rst.inc
115116

117+
.. include:: /reference/forms/types/options/help_attr.rst.inc
118+
116119
.. include:: /reference/forms/types/options/label.rst.inc
117120

118121
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/currency.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ manually, but then you should just use the ``ChoiceType`` directly.
3434
| | - `disabled`_ |
3535
| | - `empty_data`_ |
3636
| | - `help`_ |
37+
| | - `help_attr`_ |
3738
| | - `label`_ |
3839
| | - `label_attr`_ |
3940
| | - `label_format`_ |
@@ -102,6 +103,8 @@ The actual default value of this option depends on other field options:
102103

103104
.. include:: /reference/forms/types/options/help.rst.inc
104105

106+
.. include:: /reference/forms/types/options/help_attr.rst.inc
107+
105108
.. include:: /reference/forms/types/options/label.rst.inc
106109

107110
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/date.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ and can understand a number of different input formats via the `input`_ option.
3636
| options | - `disabled`_ |
3737
| | - `error_mapping`_ |
3838
| | - `help`_ |
39+
| | - `help_attr`_ |
3940
| | - `inherit_data`_ |
4041
| | - `invalid_message`_ |
4142
| | - `invalid_message_parameters`_ |
@@ -209,6 +210,8 @@ These options inherit from the :doc:`FormType </reference/forms/types/form>`:
209210

210211
.. include:: /reference/forms/types/options/help.rst.inc
211212

213+
.. include:: /reference/forms/types/options/help_attr.rst.inc
214+
212215
.. include:: /reference/forms/types/options/inherit_data.rst.inc
213216

214217
.. include:: /reference/forms/types/options/invalid_message.rst.inc

‎reference/forms/types/dateinterval.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ or an array (see `input`_).
4040
| Inherited | - `data`_ |
4141
| options | - `disabled`_ |
4242
| | - `help`_ |
43+
| | - `help_attr`_ |
4344
| | - `inherit_data`_ |
4445
| | - `invalid_message`_ |
4546
| | - `invalid_message_parameters`_ |
@@ -310,6 +311,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
310311

311312
.. include:: /reference/forms/types/options/help.rst.inc
312313

314+
.. include:: /reference/forms/types/options/help_attr.rst.inc
315+
313316
.. include:: /reference/forms/types/options/inherit_data.rst.inc
314317

315318
.. include:: /reference/forms/types/options/invalid_message.rst.inc

‎reference/forms/types/datetime.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ the data can be a ``DateTime`` object, a string, a timestamp or an array.
4545
| Inherited | - `data`_ |
4646
| options | - `disabled`_ |
4747
| | - `help`_ |
48+
| | - `help_attr`_ |
4849
| | - `inherit_data`_ |
4950
| | - `invalid_message`_ |
5051
| | - `invalid_message_parameters`_ |
@@ -234,6 +235,8 @@ These options inherit from the :doc:`FormType </reference/forms/types/form>`:
234235

235236
.. include:: /reference/forms/types/options/help.rst.inc
236237

238+
.. include:: /reference/forms/types/options/help_attr.rst.inc
239+
237240
.. include:: /reference/forms/types/options/inherit_data.rst.inc
238241

239242
.. include:: /reference/forms/types/options/invalid_message.rst.inc

‎reference/forms/types/email.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The ``EmailType`` field is a text field that is rendered using the HTML5
1616
| | - `error_bubbling`_ |
1717
| | - `error_mapping`_ |
1818
| | - `help`_ |
19+
| | - `help_attr`_ |
1920
| | - `label`_ |
2021
| | - `label_attr`_ |
2122
| | - `label_format`_ |
@@ -51,6 +52,8 @@ The default value is ``''`` (the empty string).
5152

5253
.. include:: /reference/forms/types/options/help.rst.inc
5354

55+
.. include:: /reference/forms/types/options/help_attr.rst.inc
56+
5457
.. include:: /reference/forms/types/options/label.rst.inc
5558

5659
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/entity.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ objects from the database.
4242
| | - `error_bubbling`_ |
4343
| | - `error_mapping`_ |
4444
| | - `help`_ |
45+
| | - `help_attr`_ |
4546
| | - `label`_ |
4647
| | - `label_attr`_ |
4748
| | - `label_format`_ |
@@ -330,6 +331,8 @@ The actual default value of this option depends on other field options:
330331

331332
.. include:: /reference/forms/types/options/help.rst.inc
332333

334+
.. include:: /reference/forms/types/options/help_attr.rst.inc
335+
333336
.. include:: /reference/forms/types/options/label.rst.inc
334337

335338
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/file.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The ``FileType`` represents a file input in your form.
1919
| options | - `error_bubbling`_ |
2020
| | - `error_mapping`_ |
2121
| | - `help`_ |
22+
| | - `help_attr`_ |
2223
| | - `label`_ |
2324
| | - `label_attr`_ |
2425
| | - `label_format`_ |
@@ -127,6 +128,8 @@ These options inherit from the :doc:`FormType </reference/forms/types/form>`:
127128

128129
.. include:: /reference/forms/types/options/help.rst.inc
129130

131+
.. include:: /reference/forms/types/options/help_attr.rst.inc
132+
130133
.. include:: /reference/forms/types/options/label.rst.inc
131134

132135
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/form.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ on all types for which ``FormType`` is the parent.
2020
| | - `error_mapping`_ |
2121
| | - `extra_fields_message`_ |
2222
| | - `help`_ |
23+
| | - `help_attr`_ |
2324
| | - `inherit_data`_ |
2425
| | - `invalid_message`_ |
2526
| | - `invalid_message_parameters`_ |
@@ -103,6 +104,8 @@ The actual default value of this option depends on other field options:
103104

104105
.. include:: /reference/forms/types/options/help.rst.inc
105106

107+
.. include:: /reference/forms/types/options/help_attr.rst.inc
108+
106109
.. include:: /reference/forms/types/options/inherit_data.rst.inc
107110

108111
.. include:: /reference/forms/types/options/invalid_message.rst.inc

‎reference/forms/types/integer.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ integers. By default, all non-integer values (e.g. 6.78) will round down
2828
| | - `error_bubbling`_ |
2929
| | - `error_mapping`_ |
3030
| | - `help`_ |
31+
| | - `help_attr`_ |
3132
| | - `invalid_message`_ |
3233
| | - `invalid_message_parameters`_ |
3334
| | - `label`_ |
@@ -113,6 +114,8 @@ The default value is ``''`` (the empty string).
113114

114115
.. include:: /reference/forms/types/options/help.rst.inc
115116

117+
.. include:: /reference/forms/types/options/help_attr.rst.inc
C94A 118+
116119
.. include:: /reference/forms/types/options/invalid_message.rst.inc
117120

118121
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

‎reference/forms/types/language.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ manually, but then you should just use the ``ChoiceType`` directly.
4444
| | - `disabled`_ |
4545
| | - `empty_data`_ |
4646
| | - `help`_ |
47+
| | - `help_attr`_ |
4748
| | - `label`_ |
4849
| | - `label_attr`_ |
4950
| | - `label_format`_ |
@@ -115,6 +116,8 @@ The actual default value of this option depends on other field options:
115116

116117
.. include:: /reference/forms/types/options/help.rst.inc
117118

119+
.. include:: /reference/forms/types/options/help_attr.rst.inc
120+
118121
.. include:: /reference/forms/types/options/label.rst.inc
119122

120123
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/locale.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ manually, but then you should just use the ``ChoiceType`` directly.
4545
| | - `disabled`_ |
4646
| | - `empty_data`_ |
4747
| | - `help`_ |
48+
| | - `help_attr`_ |
4849
| | - `label`_ |
4950
| | - `label_attr`_ |
5051
| | - `label_format`_ |
@@ -116,6 +117,8 @@ The actual default value of this option depends on other field options:
116117

117118
.. include:: /reference/forms/types/options/help.rst.inc
118119

120+
.. include:: /reference/forms/types/options/help_attr.rst.inc
121+
119122
.. include:: /reference/forms/types/options/label.rst.inc
120123

121124
.. include:: /reference/forms/types/options/label_attr.rst.inc

‎reference/forms/types/money.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ how the input and output of the data is handled.
2929
| | - `error_bubbling`_ |
3030
| | - `error_mapping`_ |
3131
| | - `help`_ |
32+
| | - `help_attr`_ |
3233
| | - `invalid_message`_ |
3334
| | - `invalid_message_parameters`_ |
3435
| | - `label`_ |
@@ -121,6 +122,8 @@ The default value is ``''`` (the empty string).
121122

122123
.. include:: /reference/forms/types/options/help.rst.inc
123124

125+
.. include:: /reference/forms/types/options/help_attr.rst.inc
126+
124127
.. include:: /reference/forms/types/options/invalid_message.rst.inc
125128

126129
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

‎reference/forms/types/number.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ that you want to use for your number.
2424
| | - `error_bubbling`_ |
2525
| | - `error_mapping`_ |
2626
| | - `help`_ |
27+
| | - `help_attr`_ |
2728
| | - `invalid_message`_ |
2829
| | - `invalid_message_parameters`_ |
2930
| | - `label`_ |
@@ -86,6 +87,8 @@ The default value is ``''`` (the empty string).
8687

8788
.. include:: /reference/forms/types/options/help.rst.inc
8889

90+
.. include:: /reference/forms/types/options/help_attr.rst.inc
91+
8992
.. include:: /reference/forms/types/options/invalid_message.rst.inc
9093

9194
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

0 commit comments

Comments
 (0)
0