minor #19114 [Options Resolver] Using placeholder to use dynamic parameter (devojifr)

OskarStark · OskarStark · commit f3f98b07fd59 · 2023-11-07T08:36:28.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Options Resolver] Using placeholder to use dynamic parameter The comment specifies the %name% placeholder possibility. We can use it to give a better understanding of the custom deprecation message. I also add a reminder about where deprecations are displayed. Commits ------- fd72006 [Options Resolver] Using placeholder to use dynamic parameter
diff --git a/components/options_resolver.rst b/components/options_resolver.rst
@@ -801,11 +801,14 @@ method::
         ->setDeprecated('hostname', 'acme/package', '1.2')
 
         // you can also pass a custom deprecation message (%name% placeholder is available)
+        // %name% placeholder will be replaced by the deprecated option.
+        // This outputs the following deprecation message:
+        // Since acme/package 1.2: The option "hostname" is deprecated, use "host" instead.
         ->setDeprecated(
             'hostname',
             'acme/package',
             '1.2',
-            'The option "hostname" is deprecated, use "host" instead.'
+            'The option "%name%" is deprecated, use "host" instead.'
         )
     ;
 
@@ -822,6 +825,10 @@ method::
     :method:`Symfony\\Component\\OptionsResolver\\Options::offsetGet` method
     to not trigger the deprecation warning.
 
+.. note::
+
+    All deprecation messages are displayed in the profiler logs into Deprecations tab.
+
 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
