Commits

Andriy Kornatskyy committed c5d3491

Added documentation for new rules: regex, slug, email and range

  • Participants
  • Parent commits ec3de50

Comments (0)

Files changed (1)

doc/userguide.rst

 * ``compare``. Compares attribute being validated with some other attribute
   value. Supported comparison operations include: ``equal``. See 
   :py:class:`~wheezy.validation.rules.CompareRule`.
+* ``regex``. Search for regular expression pattern. Initialized with 
+  ``regex`` as a regular expression pattern or a pre-compiled regular 
+  expression. See :py:class:`~wheezy.validation.rules.RegexRule`.
+* ``slug``. Ensures only letters, numbers, underscores or hyphens. See 
+  :py:class:`~wheezy.validation.rules.SlugRule`.
+* ``email``. Ensures a valid email. See 
+  :py:class:`~wheezy.validation.rules.EmailRule`.
+* ``range``. Ensures value is in range defined by this rule. Works with any 
+  numbers including int, float, decimal, etc. Supported range attributes 
+  include: ``min``, ``max``. See 
+  :py:class:`~wheezy.validation.rules.RangeRule`.
 
 Custom Message
 ~~~~~~~~~~~~~~
         'username': [required(message_template='Required field')]
     })
 
+Every rule supports ``message_template`` argument during rule declaration.
+
 ``gettext`` utilities
 ^^^^^^^^^^^^^^^^^^^^^