Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit e44c791

Browse filesBrowse files
committed
feature #4047 Documented info method (WouterJ)
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #4047). Discussion ---------- Documented info method | Q | A | --- | --- | Doc fix? | no | New docs? | yes (symfony/symfony#11453) | Applies to | 2.6+ | Fixed tickets | - Commits ------- 37d5361 Documented info method
2 parents c332063 + e211f56 commit e44c791
Copy full SHA for e44c791

File tree

Expand file treeCollapse file tree

1 file changed

+13
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+13
-0
lines changed

‎components/config/definition.rst

Copy file name to clipboardExpand all lines: components/config/definition.rst
+13Lines 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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.