Skip to content

Commit e211f56

Browse files
wouterjweaverryan
authored andcommitted
Documented info method
1 parent c332063 commit e211f56

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
@@ -287,6 +287,19 @@ has a certain value:
287287
->end()
288288
;
289289
290+
Documenting the Option
291+
----------------------
292+
293+
All options can be documented using the
294+
:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::info`
295+
method.
296+
297+
The info will be printed as a comment when dumping the configuration tree.
298+
299+
.. versionadded:: 2.6
300+
Since Symfony 2.6, the info will also be added to the exception message
301+
when an invalid type is given.
302+
290303
Optional Sections
291304
-----------------
292305

0 commit comments

Comments
 (0)