From e211f56630896ac58b6733786dd4c0b633c1568b Mon Sep 17 00:00:00 2001 From: WouterJ Date: Wed, 23 Jul 2014 16:53:09 +0200 Subject: [PATCH 1/2] Documented info method --- components/config/definition.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/components/config/definition.rst b/components/config/definition.rst index f16c35d7d60..10a74f8ddd2 100644 --- a/components/config/definition.rst +++ b/components/config/definition.rst @@ -287,6 +287,19 @@ has a certain value: ->end() ; +Documenting the Option +---------------------- + +All options can be documented using the +:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::info` +method. + +The info will be printed as a comment when dumping the configuration tree. + +.. versionadded:: 2.6 + Since Symfony 2.6, the info will also be added to the exception message + when an invalid type is given. + Optional Sections ----------------- From 0b157d29efe59cee3ed4f31802680ee0a421924a Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Wed, 1 Oct 2014 09:36:56 -0400 Subject: [PATCH 2/2] Removing 2.6 message from the 2.3 branch --- components/config/definition.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/components/config/definition.rst b/components/config/definition.rst index 10a74f8ddd2..296fd9197ba 100644 --- a/components/config/definition.rst +++ b/components/config/definition.rst @@ -296,10 +296,6 @@ method. The info will be printed as a comment when dumping the configuration tree. -.. versionadded:: 2.6 - Since Symfony 2.6, the info will also be added to the exception message - when an invalid type is given. - Optional Sections -----------------