RegexValidator documentation minor problems

[Simon Meers]

In 'RegexValidator' section of documentation (​http://code.djangoproject.com/browser/django/trunk/docs/ref/validators.txt#L59) there seem to be several minor problems:

• Default value stated as None in method signature, but 'invalid' in details
• Order of parameters in details differs to method signature (confusing)
• Insufficient explanation of the purpose of the code parameter

[Simon Meers]

Oops, marked wrong milestone initially. This really shouldn't hang around.

[David Fischer]

Improved RegexValidator documentation

[David Fischer]

I added a patch that addresses the three points made by the ticket originator. In general, however, the validator documentation could use a little love. I think another ticket may be in order.

[Russell Keith-Magee]

(In [13148]) Fixed #13341 -- Clarified the arguments to RegexValidators. Thanks to DrMeers for the report, and David Fischer for the draft text.

[David Fischer]

Clarification update regarding the first parameter "regex"

[David Fischer]

While the original patch was being cleaned up and committed, there was a slight change to try to rectify the documentation with what the actual source code says. The first patch changed the documentation such that it appeared that the first parameter of RegexValidator -- the regex pattern regex -- is required. The code says that it is optional. While it is technically an optional parameter, a TypeError is thrown if it is not provided (see traceback). The documentation should be updated such that users don't try to use the defaults. They should always provide the regex parameter. The update patch makes it clear that regex is required. I don't like the idea of having the docs technically out of sync with the code, but I think it is the best option in this instance.

I opened ticket #13511 regarding changing the regex parameter to required.

>>> from django.core.validators import RegexValidator
>>> RegexValidator()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/private/tmp/testarea/lib/python2.6/site-packages/django/core/validators.py", line 32, in __init__
    self.regex = re.compile(regex)
  File "/private/tmp/testarea/lib/python2.6/re.py", line 190, in compile
    return _compile(pattern, flags)
  File "/private/tmp/testarea/lib/python2.6/re.py", line 241, in _compile
    raise TypeError, "first argument must be string or compiled pattern"
TypeError: first argument must be string or compiled pattern

[Russell Keith-Magee]

(In [13201]) Fixed #13341 -- Clarified default arguments to the RegexValidator. Thanks to David Fischer for the report and patch.

[Jacob]

Milestone 1.2 deleted