minor #8509 Added info about deprecation reporting of YAML lint command (hiddewie)

xabbuh · xabbuh · commit 3618a60549e2 · 2017-10-13T09:20:17.000+02:00
This PR was merged into the 3.3 branch. Discussion ---------- Added info about deprecation reporting of YAML lint command Fixes #7780. It seems useful to add a use case for the reporting, I've added a line about finding deprecations during automated testing. Commits ------- 47a18e5 Added info about deprecation reporting of YAML lint command
diff --git a/components/yaml.rst b/components/yaml.rst
@@ -368,6 +368,12 @@ Add the ``--format`` option to get the output in JSON format:
 
     $ php lint.php path/to/file.yml --format json
 
+.. tip::
+
+    The linting command will also report any deprecations in the checked
+    YAML files. This may for example be useful for recognizing deprecations of
+    contents of YAML files during automated tests.
+
 Learn More
 ----------
 
