Tweak the IsTrue validation docs #12712
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OskarStark
approved these changes
Nov 27, 2019
xabbuh
requested changes
Nov 27, 2019
reference/constraints/IsTrue.rst
Outdated
| @@ -113,7 +112,9 @@ Then you can constrain this method with ``IsTrue``. | |||
| } | |||
| } | |||
|
|
|||
| If the ``isTokenValid()`` returns false, the validation will fail. | |||
| If the ``isTokenValid()`` returns false, the validation will fail. When applied | |||
| to methods, this constraint requires method names to start with ``is`` or | |||
There was a problem hiding this comment.
This does not look right to me. Is this based on some bug report?
There was a problem hiding this comment.
The original doc said that this works with "a "getter" method" But what's that? Only getters? Because I know that it works for issers too ... so, getters + issers only? Or does this work with ANY kind of method regardless of its name? Thanks.
There was a problem hiding this comment.
This works with an method that returns a boolean value.
There was a problem hiding this comment.
Thanks for clarifying this. I've updated the description.
xabbuh
approved these changes
Nov 27, 2019
7ccf167 to
c47d8ae
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please review that this is correct: IsTrue requires that method names start with "is" or "get" Thanks!