Skip to content

Commit 1f384bc

Browse files
committed
minor #3631 Added documentation for message option of the True constraint (naitsirch)
This PR was merged into the 2.3 branch. Discussion ---------- Added documentation for message option of the `True` constraint This PR adds the documentation of the option `message` of the `True` constraint. | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | none Commits ------- baa67dd Added documentation for message option of the `True` constraint
2 parents f6a41b9 + baa67dd commit 1f384bc

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

reference/constraints/Valid.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ object and all sub-objects associated with it.
99
| Applies to | :ref:`property or method <validation-property-target>` |
1010
+----------------+---------------------------------------------------------------------+
1111
| Options | - `traverse`_ |
12+
| | - `message`_ |
1213
+----------------+---------------------------------------------------------------------+
1314
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Type` |
1415
+----------------+---------------------------------------------------------------------+
@@ -265,3 +266,10 @@ traverse
265266
If this constraint is applied to a property that holds an array of objects,
266267
then each object in that array will be validated only if this option is set
267268
to ``true``.
269+
270+
message
271+
~~~~~~~
272+
273+
**type**: ``string`` **default**: ``This value should be true.``
274+
275+
This is the message that will be shown if the value is false.

0 commit comments

Comments
 (0)