Skip to content

Commit

Permalink
minor #3631 Added documentation for message option of the True cons…
Browse files Browse the repository at this point in the history
…traint (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
  • Loading branch information
weaverryan committed Mar 12, 2014
2 parents f6a41b9 + baa67dd commit 1f384bc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions reference/constraints/Valid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ object and all sub-objects associated with it.
| Applies to | :ref:`property or method <validation-property-target>` |
+----------------+---------------------------------------------------------------------+
| Options | - `traverse`_ |
| | - `message`_ |
+----------------+---------------------------------------------------------------------+
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Type` |
+----------------+---------------------------------------------------------------------+
Expand Down Expand Up @@ -265,3 +266,10 @@ traverse
If this constraint is applied to a property that holds an array of objects,
then each object in that array will be validated only if this option is set
to ``true``.

message
~~~~~~~

**type**: ``string`` **default**: ``This value should be true.``

This is the message that will be shown if the value is false.

0 comments on commit 1f384bc

Please sign in to comment.