minor #11704 [OptionsResolver] Add note about deprecated options (yceruto)

javiereguiluz · javiereguiluz · commit 06e0faa36fb5 · 2019-06-11T17:38:10.000+02:00
This PR was squashed before being merged into the 4.2 branch (closes #11704). Discussion ---------- [OptionsResolver] Add note about deprecated options Missing piece related to symfony/symfony#28878 Commits ------- aaac426 [OptionsResolver] Add note about deprecated options
diff --git a/components/options_resolver.rst b/components/options_resolver.rst
@@ -733,6 +733,12 @@ method::
     somewhere, either its value is provided by the user or the option is evaluated
     within closures of lazy options and normalizers.
 
+.. note::
+
+    If you use your own deprecated option within your own library and need to fix it, 
+    pass ``false`` as second argument of the :method:`Symfony\\Component\\OptionsResolver\\Options::offsetGet()` method 
+    so as not to trigger the deprecation warning.
+
 Instead of passing the message, you may also pass a closure which returns
 a string (the deprecation message) or an empty string to ignore the deprecation.
 This closure is useful to only deprecate some of the allowed types or values of
