provide_deprecation_message
Provide a deprecation message, via @Deprecated("message")
.
This rule is available as of Dart 2.2.
Rule sets: core, recommended, flutter
Details
#DO specify a deprecation message (with migration instructions and/or a removal schedule) in the Deprecated
constructor.
BAD:
dart
@deprecated
void oldFunction(arg1, arg2) {}
GOOD:
dart
@Deprecated("""
[oldFunction] is being deprecated in favor of [newFunction] (with slightly
different parameters; see [newFunction] for more information). [oldFunction]
will be removed on or after the 4.0.0 release.
""")
void oldFunction(arg1, arg2) {}
Usage
#To enable the provide_deprecation_message
rule, add provide_deprecation_message
under linter > rules in your analysis_options.yaml
file:
analysis_options.yaml
yaml
linter:
rules:
- provide_deprecation_message
Unless stated otherwise, the documentation on this site reflects Dart 3.5.3. Page last updated on 2024-07-03. View source or report an issue.