Skip to content

Commit 37d5361

Browse files
committed
Documented info method
1 parent 47fe03a commit 37d5361

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

components/config/definition.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,19 @@ has a certain value:
281281
->end()
282282
;
283283
284+
Documenting the Option
285+
----------------------
286+
287+
All options can be documented using the
288+
:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::info`
289+
method.
290+
291+
The info will be printed as a comment when dumping the configuration tree.
292+
293+
.. versionadded:: 2.6
294+
Since Symfony 2.6, the info will also be added to the exception message
295+
when an invalid type is given.
296+
284297
Optional Sections
285298
-----------------
286299

0 commit comments

Comments
 (0)