From 244c4c06f9fbcb5fe96511c8f22b0ee4856baf18 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Fri, 9 Sep 2016 11:00:21 -0400 Subject: [PATCH] [1.10.x] Normalized spelling of ETag. Backport of ef021412d5e7eb78c89f0b7cf2ec01bcb959a837 from master --- django/conf/global_settings.py | 2 +- django/views/decorators/http.py | 2 +- docs/ref/middleware.txt | 2 +- docs/ref/settings.txt | 2 +- docs/spelling_wordlist | 1 - docs/topics/conditional-view-processing.txt | 2 +- tests/admin_views/tests.py | 2 +- tests/cache/tests.py | 2 +- 8 files changed, 7 insertions(+), 8 deletions(-) diff --git a/django/conf/global_settings.py b/django/conf/global_settings.py index 576ff6b724..7183d20ffb 100644 --- a/django/conf/global_settings.py +++ b/django/conf/global_settings.py @@ -22,7 +22,7 @@ DEBUG = False # on a live site. DEBUG_PROPAGATE_EXCEPTIONS = False -# Whether to use the "Etag" header. This saves bandwidth but slows down performance. +# Whether to use the "ETag" header. This saves bandwidth but slows down performance. USE_ETAGS = False # People who get code error notifications. diff --git a/django/views/decorators/http.py b/django/views/decorators/http.py index 2dc923768d..a5144421d5 100644 --- a/django/views/decorators/http.py +++ b/django/views/decorators/http.py @@ -58,7 +58,7 @@ def condition(etag_func=None, last_modified_func=None): The parameters are callables to compute the ETag and last modified time for the requested resource, respectively. The callables are passed the same - parameters as the view itself. The Etag function should return a string (or + parameters as the view itself. The ETag function should return a string (or None if the resource doesn't exist), while the last_modified function should return a datetime object (or None if the resource doesn't exist). diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt index 2d1d0f9604..af851f64a6 100644 --- a/docs/ref/middleware.txt +++ b/docs/ref/middleware.txt @@ -462,7 +462,7 @@ Here are some hints about the ordering of various Django middleware classes: #. :class:`~django.middleware.http.ConditionalGetMiddleware` - Before ``CommonMiddleware``: uses its ``Etag`` header when + Before ``CommonMiddleware``: uses its ``ETag`` header when :setting:`USE_ETAGS` = ``True``. #. :class:`~django.contrib.sessions.middleware.SessionMiddleware` diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index d17b224355..34c4dda324 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -2486,7 +2486,7 @@ to ensure your processes are running in the correct environment. Default: ``False`` -A boolean that specifies whether to output the "Etag" header. This saves +A boolean that specifies whether to output the ``ETag`` header. This saves bandwidth but slows down performance. This is used by the ``CommonMiddleware`` (see :doc:`/topics/http/middleware`) and in the``Cache Framework`` (see :doc:`/topics/cache`). diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index c9fb05f5ea..e1549eee14 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -239,7 +239,6 @@ environ escapejs esque Ess -Etag ETag ETags exe diff --git a/docs/topics/conditional-view-processing.txt b/docs/topics/conditional-view-processing.txt index 0045efa49d..7efd8ac636 100644 --- a/docs/topics/conditional-view-processing.txt +++ b/docs/topics/conditional-view-processing.txt @@ -64,7 +64,7 @@ order, as the view function they are helping to wrap. The function passed ``last_modified_func`` should return a standard datetime value specifying the last time the resource was modified, or ``None`` if the resource doesn't exist. The function passed to the ``etag`` decorator should return a string -representing the `Etag`_ for the resource, or ``None`` if it doesn't exist. +representing the `ETag`_ for the resource, or ``None`` if it doesn't exist. Using this feature usefully is probably best explained with an example. Suppose you have this pair of models, representing a simple blog system:: diff --git a/tests/admin_views/tests.py b/tests/admin_views/tests.py index 8d663e589b..79b07f6bc9 100644 --- a/tests/admin_views/tests.py +++ b/tests/admin_views/tests.py @@ -5990,7 +5990,7 @@ class InlineAdminViewOnSiteTest(TestCase): @override_settings(ROOT_URLCONF='admin_views.urls') -class TestEtagWithAdminView(SimpleTestCase): +class TestETagWithAdminView(SimpleTestCase): # See https://code.djangoproject.com/ticket/16003 def test_admin(self): diff --git a/tests/cache/tests.py b/tests/cache/tests.py index dffd54c984..02ff30d899 100644 --- a/tests/cache/tests.py +++ b/tests/cache/tests.py @@ -2078,7 +2078,7 @@ class TestWithTemplateResponse(SimpleTestCase): Tests various headers w/ TemplateResponse. Most are probably redundant since they manipulate the same object - anyway but the Etag header is 'special' because it relies on the + anyway but the ETag header is 'special' because it relies on the content being complete (which is not necessarily always the case with a TemplateResponse) """