@@ -16,7 +16,7 @@ Apparently `some other guys have felt the same way`_.
1616 http://opensourcehacker.com/2011/07/07/generic-python-validation-frameworks/
1717
1818Often I've had for example a case where I just wanted to check if given string
19- is an email. With `validators ` this use case becomes as easy as::
19+ is an email. With `` validators ` ` this use case becomes as easy as::
2020
2121 >>> import validators
2222
@@ -32,26 +32,26 @@ You can install ``validators`` using pip::
3232
3333 pip install validators
3434
35- Currently validators supports Python versions 2.6, 2.7 and 3.3.
35+ Currently `` validators `` supports Python versions 2.6, 2.7 and 3.3.
3636
3737
3838Basic validators
3939================
4040
41- Each validator in `validators ` is a simple function that takes the value to
41+ Each validator in `` validators ` ` is a simple function that takes the value to
4242validate and possibly some additional key-value arguments. Each function returns
43- `True ` when validation succeeds and ValidationFailure object when validation
44- fails.
43+ `` True `` when validation succeeds and
44+ :class: ` ~validators.utils.ValidationFailure ` object when validation fails.
4545
46- ValidationFailure class implements __bool__ method so you can easily check if
47- validation failed::
46+ :class: ` ~validators.utils. ValidationFailure` class implements `` __bool__ ``
47+ method so you can easily check if validation failed::
4848
4949 if not email('some_bogus_email@@@'):
5050 # Do something here
5151 pass
5252
53- ValidationFailure object also holds all the arguments passed to original
54- function::
53+ :class: ` ~validators.utils. ValidationFailure` object also holds all the arguments
54+ passed to original function::
5555
5656 result = number_range(3, min=5)
5757 if not result:
@@ -164,4 +164,5 @@ validator
164164
165165.. module :: validators.utils
166166
167+ .. autoclass :: ValidationFailure
167168.. autofunction :: validator
0 commit comments