Skip to content

[OptionsResolver] Add some notes about trigger deprecation #10496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2018
Merged

[OptionsResolver] Add some notes about trigger deprecation #10496

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add some notes about trigger deprecation
  • Loading branch information
@yceruto
yceruto committed Oct 16, 2018
commit bb4861b9b91950d6b4f4bb6871b19afd63bf535b
11 changes: 11 additions & 0 deletions components/options_resolver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,12 @@ method::
->setDeprecated('hostname', 'The option "hostname" is deprecated, use "host" instead.')
;

.. note::

The deprecation message will be triggered only if the option is being used
somewhere, either its value is provided by the user or the option is evaluated
within closures of lazy options and normalizers.

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
Expand All @@ -677,6 +683,11 @@ the option::
})
;

.. note::

Deprecation based on the value is triggered only when the option is provided
by the user.

This closure receives as argument the value of the option after validating it
and before normalizing it when the option is being resolved.

Expand Down