diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 9 | ||||
| -rw-r--r-- | docs/ref/forms/api.txt | 8 | ||||
| -rw-r--r-- | docs/ref/forms/validation.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.7.txt | 11 | ||||
| -rw-r--r-- | docs/topics/forms/formsets.txt | 2 |
5 files changed, 29 insertions, 5 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 054e3b32fc..9e473dfa46 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -444,6 +444,15 @@ these changes. * ``ModelAdmin.declared_fieldsets`` will be removed. +* Instances of ``util.py`` in the Django codebase have been renamed to + ``utils.py`` in an effort to unify all util and utils references. + The modules that provided backwards compatability will be removed: + + * ``django.contrib.admin.util`` + * ``django.contrib.gis.db.backends.util`` + * ``django.db.backends.util`` + * ``django.forms.util`` + 2.0 --- diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index f084273cd9..977da4b7be 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -571,12 +571,12 @@ method you're using:: Customizing the error list format ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -By default, forms use ``django.forms.util.ErrorList`` to format validation +By default, forms use ``django.forms.utils.ErrorList`` to format validation errors. If you'd like to use an alternate class for displaying errors, you can pass that in at construction time (replace ``__unicode__`` by ``__str__`` on Python 3):: - >>> from django.forms.util import ErrorList + >>> from django.forms.utils import ErrorList >>> class DivErrorList(ErrorList): ... def __unicode__(self): ... return self.as_divs() @@ -592,6 +592,10 @@ Python 3):: <p>Sender: <input type="email" name="sender" value="invalid email address" /></p> <p>Cc myself: <input checked="checked" type="checkbox" name="cc_myself" /></p> +.. versionchanged:: 1.7 + + ``django.forms.util`` was renamed to ``django.forms.utils``. + More granular output ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/ref/forms/validation.txt b/docs/ref/forms/validation.txt index b6113098bb..c1e619113c 100644 --- a/docs/ref/forms/validation.txt +++ b/docs/ref/forms/validation.txt @@ -219,10 +219,10 @@ through the ``Form.non_field_errors()`` method. When you really do need to attach the error to a particular field, you should store (or amend) a key in the ``Form._errors`` attribute. This attribute is an -instance of a ``django.forms.util.ErrorDict`` class. Essentially, though, it's +instance of a ``django.forms.utils.ErrorDict`` class. Essentially, though, it's just a dictionary. There is a key in the dictionary for each field in the form that has an error. Each value in the dictionary is a -``django.forms.util.ErrorList`` instance, which is a list that knows how to +``django.forms.utils.ErrorList`` instance, which is a list that knows how to display itself in different ways. So you can treat ``_errors`` as a dictionary mapping field names to lists. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 3e247fd211..685efe04b3 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -460,3 +460,14 @@ a bug and has been addressed. The ``syncdb`` command has been deprecated in favour of the new ``migrate`` command. ``migrate`` takes the same arguments as ``syncdb`` used to plus a few more, so it's safe to just change the name you're calling and nothing else. + +``util`` modules renamed to ``utils`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following instances of ``util.py`` in the Django codebase have been renamed +to ``utils.py`` in an effort to unify all util and utils references: + +* ``django.contrib.admin.util`` +* ``django.contrib.gis.db.backends.util`` +* ``django.db.backends.util`` +* ``django.forms.util`` diff --git a/docs/topics/forms/formsets.txt b/docs/topics/forms/formsets.txt index 8be6e10ff6..384187bdaf 100644 --- a/docs/topics/forms/formsets.txt +++ b/docs/topics/forms/formsets.txt @@ -215,7 +215,7 @@ this management data, an exception will be raised:: >>> formset = ArticleFormSet(data) Traceback (most recent call last): ... - django.forms.util.ValidationError: [u'ManagementForm data is missing or has been tampered with'] + django.forms.utils.ValidationError: [u'ManagementForm data is missing or has been tampered with'] It is used to keep track of how many form instances are being displayed. If you are adding new forms via JavaScript, you should increment the count fields |