From b4f5655c8616664216dd5c495c33edc10a147655 Mon Sep 17 00:00:00 2001 From: Gary Wilson Jr Date: Tue, 31 Mar 2009 16:07:07 +0000 Subject: [PATCH] Fixed #10553 -- Corrected several uses of `URLconf` in documentation and comments, according to the Django style guide. Based on patch from rduffield. git-svn-id: http://code.djangoproject.com/svn/django/trunk@10256 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- django/contrib/admin/__init__.py | 2 +- django/contrib/admin/sites.py | 2 +- django/contrib/auth/tests/views.py | 4 ++-- django/contrib/formtools/test_urls.py | 6 ++---- django/core/urlresolvers.py | 4 ++-- docs/howto/deployment/modpython.txt | 8 ++++---- docs/ref/models/instances.txt | 2 +- docs/releases/1.1-alpha-1.txt | 2 +- docs/topics/http/urls.txt | 4 ++-- tests/regressiontests/test_client_regress/models.py | 2 +- 10 files changed, 17 insertions(+), 19 deletions(-) diff --git a/django/contrib/admin/__init__.py b/django/contrib/admin/__init__.py index f8bfde1f5b..8105976591 100644 --- a/django/contrib/admin/__init__.py +++ b/django/contrib/admin/__init__.py @@ -15,7 +15,7 @@ def autodiscover(): may want. """ # Bail out if autodiscover didn't finish loading from a previous call so - # that we avoid running autodiscover again when the URLConf is loaded by + # that we avoid running autodiscover again when the URLconf is loaded by # the exception handler to resolve the handler500 view. This prevents an # admin.py module with errors from re-registering models and raising a # spurious AlreadyRegistered exception (see #8245). diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index 872e4a02c0..e2b246aec3 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -24,7 +24,7 @@ class NotRegistered(Exception): class AdminSite(object): """ An AdminSite object encapsulates an instance of the Django admin application, ready - to be hooked in to your URLConf. Models are registered with the AdminSite using the + to be hooked in to your URLconf. Models are registered with the AdminSite using the register() method, and the root() method can then be used as a Django view function that presents a full admin interface for the collection of registered models. """ diff --git a/django/contrib/auth/tests/views.py b/django/contrib/auth/tests/views.py index ec98cf07f7..3e5cbabf05 100644 --- a/django/contrib/auth/tests/views.py +++ b/django/contrib/auth/tests/views.py @@ -47,8 +47,8 @@ class PasswordResetTest(TestCase): def test_confirm_invalid(self): url, path = self._test_confirm_start() - # Lets munge the token in the path, but keep the same length, - # in case the URL conf will reject a different length + # Let's munge the token in the path, but keep the same length, + # in case the URLconf will reject a different length. path = path[:-5] + ("0"*4) + path[-1] response = self.client.get(path) diff --git a/django/contrib/formtools/test_urls.py b/django/contrib/formtools/test_urls.py index 19dbbd1ae4..44a58d2a7f 100644 --- a/django/contrib/formtools/test_urls.py +++ b/django/contrib/formtools/test_urls.py @@ -1,9 +1,7 @@ """ +This is a URLconf to be loaded by tests.py. Add any URLs needed for tests only. +""" -This is a urlconf to be loaded by tests.py. Add any urls needed -for tests only. - -""" from django.conf.urls.defaults import * from django.contrib.formtools.tests import * diff --git a/django/core/urlresolvers.py b/django/core/urlresolvers.py index 6fc5cfce74..042e0b81d5 100644 --- a/django/core/urlresolvers.py +++ b/django/core/urlresolvers.py @@ -24,7 +24,7 @@ except NameError: from django.utils.itercompat import reversed # Python 2.3 fallback from sets import Set as set -_resolver_cache = {} # Maps urlconf modules to RegexURLResolver instances. +_resolver_cache = {} # Maps URLconf modules to RegexURLResolver instances. _callable_cache = {} # Maps view and url pattern names to their view functions. # SCRIPT_NAME prefixes for each thread are stored here. If there's no entry for @@ -141,7 +141,7 @@ class RegexURLPattern(object): class RegexURLResolver(object): def __init__(self, regex, urlconf_name, default_kwargs=None): # regex is a string representing a regular expression. - # urlconf_name is a string representing the module containing urlconfs. + # urlconf_name is a string representing the module containing URLconfs. self.regex = re.compile(regex, re.UNICODE) self.urlconf_name = urlconf_name if not isinstance(urlconf_name, basestring): diff --git a/docs/howto/deployment/modpython.txt b/docs/howto/deployment/modpython.txt index 70f1e37749..14f0219421 100644 --- a/docs/howto/deployment/modpython.txt +++ b/docs/howto/deployment/modpython.txt @@ -58,12 +58,12 @@ be passed through to the mod_python handler in Django, via the ``PythonOption django.root ...`` line. The value set on that line (the last item) should match the string given in the ```` directive. The effect of this is that Django will automatically strip the ``/mysite`` string from the front -of any URLs before matching them against your ``URLConf`` patterns. If you -later move your site to live under ``/mysite2``, you will not have to change -anything except the ``django.root`` option in the config file. +of any URLs before matching them against your URLconf patterns. If you later +move your site to live under ``/mysite2``, you will not have to change anything +except the ``django.root`` option in the config file. When using ``django.root`` you should make sure that what's left, after the -prefix has been removed, begins with a slash. Your URLConf patterns that are +prefix has been removed, begins with a slash. Your URLconf patterns that are expecting an initial slash will then work correctly. In the above example, since we want to send things like ``/mysite/admin/`` to ``/admin/``, we need to remove the string ``/mysite`` from the beginning, so that is the diff --git a/docs/ref/models/instances.txt b/docs/ref/models/instances.txt index 5e7151a89c..b2b04e04d5 100644 --- a/docs/ref/models/instances.txt +++ b/docs/ref/models/instances.txt @@ -290,7 +290,7 @@ The ``permalink`` decorator The problem with the way we wrote ``get_absolute_url()`` above is that it slightly violates the DRY principle: the URL for this object is defined both -in the URLConf file and in the model. +in the URLconf file and in the model. You can further decouple your models from the URLconf using the ``permalink`` decorator: diff --git a/docs/releases/1.1-alpha-1.txt b/docs/releases/1.1-alpha-1.txt index fa6f494a48..8cd695ef2d 100644 --- a/docs/releases/1.1-alpha-1.txt +++ b/docs/releases/1.1-alpha-1.txt @@ -82,7 +82,7 @@ Other new features and changes introduced since Django 1.0 include: (sending admin requests to the ``admin.site.root`` view still works, but URLs in the admin will not be "reversible" when configured this way). -* The ``include()`` function in Django URLConf modules can now accept sequences +* The ``include()`` function in Django URLconf modules can now accept sequences of URL patterns (generated by ``patterns()``) in addition to module names. * Instances of Django forms (see `the forms overview `_ now diff --git a/docs/topics/http/urls.txt b/docs/topics/http/urls.txt index 4f94b82e47..0d0f9ac889 100644 --- a/docs/topics/http/urls.txt +++ b/docs/topics/http/urls.txt @@ -623,13 +623,13 @@ reverse such patterns. .. admonition:: Make sure your views are all correct As part of working out which URL names map to which patterns, the - ``reverse()`` function has to import all of your URLConf files and examine + ``reverse()`` function has to import all of your URLconf files and examine the name of each view. This involves importing each view function. If there are *any* errors whilst importing any of your view functions, it will cause ``reverse()`` to raise an error, even if that view function is not the one you are trying to reverse. - Make sure that any views you reference in your URLConf files exist and can + Make sure that any views you reference in your URLconf files exist and can be imported correctly. Do not include lines that reference views you haven't written yet, because those views will not be importable. diff --git a/tests/regressiontests/test_client_regress/models.py b/tests/regressiontests/test_client_regress/models.py index 71d6a149d0..90383dba84 100644 --- a/tests/regressiontests/test_client_regress/models.py +++ b/tests/regressiontests/test_client_regress/models.py @@ -444,7 +444,7 @@ class UrlconfSubstitutionTests(TestCase): urls = 'regressiontests.test_client_regress.urls' def test_urlconf_was_changed(self): - "TestCase can enforce a custom URLConf on a per-test basis" + "TestCase can enforce a custom URLconf on a per-test basis" url = reverse('arg_view', args=['somename']) self.assertEquals(url, '/arg_view/somename/')