minor #5957 mark deep option as deprecated (snoek09)

This PR was merged into the 2.7 branch. Discussion ---------- mark deep option as deprecated | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.7 | Fixed tickets | #5944 Commits ------- bc8293b mark deep option as deprecated
symfony · Dec 9, 2015 · 03aa3d9 · 03aa3d9
2 parents 7186d17 + bc8293b
commit 03aa3d9
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/reference/constraints/Valid.rst b/reference/constraints/Valid.rst
@@ -9,7 +9,7 @@ an object and all sub-objects associated with it.
 | Applies to     | :ref:`property or method <validation-property-target>`              |
 +----------------+---------------------------------------------------------------------+
 | Options        | - `traverse`_                                                       |
-|                | - `deep`_                                                           |
+|                | - `deep`_ (deprecated as of 2.5)                                    |
 |                | - `payload`_                                                        |
 +----------------+---------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\Valid`          |
@@ -271,6 +271,12 @@ set to ``true``.
 deep
 ~~~~
 
+.. caution::
+
+    The ``deep`` option was deprecated in Symfony 2.5 and will be removed
+    in Symfony 3.0. When traversing arrays, nested arrays are always traversed.
+    When traversing nested objects, their traversal strategy is used.
+
 **type**: ``boolean`` **default**: ``false``
 
 If this constraint is applied to a property that holds an array of objects,