From ee26797cff6ef17817c58e6a2f86db81c21f9800 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 29 Jan 2013 08:45:40 -0700 Subject: [PATCH] Fixed typos in docs and comments --- django/contrib/gis/gdal/geometries.py | 2 +- django/contrib/gis/geos/prototypes/geom.py | 2 +- django/contrib/gis/utils/srs.py | 2 +- django/contrib/staticfiles/views.py | 2 +- django/db/models/query.py | 2 +- django/middleware/csrf.py | 4 ++-- docs/internals/contributing/committing-code.txt | 2 +- docs/internals/contributing/writing-code/working-with-git.txt | 4 ++-- docs/intro/overview.txt | 4 +++- docs/misc/api-stability.txt | 3 ++- docs/ref/contrib/admin/index.txt | 2 +- docs/ref/contrib/gis/install/index.txt | 2 +- docs/topics/auth/default.txt | 2 +- tests/regressiontests/admin_views/tests.py | 2 +- tests/regressiontests/builtin_server/tests.py | 2 +- 15 files changed, 20 insertions(+), 17 deletions(-) diff --git a/django/contrib/gis/gdal/geometries.py b/django/contrib/gis/gdal/geometries.py index eb670592458..0d75620b4e9 100644 --- a/django/contrib/gis/gdal/geometries.py +++ b/django/contrib/gis/gdal/geometries.py @@ -76,7 +76,7 @@ class OGRGeometry(GDALBase): str_instance = isinstance(geom_input, six.string_types) - # If HEX, unpack input to to a binary buffer. + # If HEX, unpack input to a binary buffer. if str_instance and hex_regex.match(geom_input): geom_input = memoryview(a2b_hex(geom_input.upper().encode())) str_instance = False diff --git a/django/contrib/gis/geos/prototypes/geom.py b/django/contrib/gis/geos/prototypes/geom.py index 5a614fe5f06..2683c2e25d8 100644 --- a/django/contrib/gis/geos/prototypes/geom.py +++ b/django/contrib/gis/geos/prototypes/geom.py @@ -27,7 +27,7 @@ def bin_constructor(func): # HEX & WKB output def bin_output(func): - "Generates a prototype for the routines that return a a sized string." + "Generates a prototype for the routines that return a sized string." func.argtypes = [GEOM_PTR, POINTER(c_size_t)] func.errcheck = check_sized_string func.restype = c_uchar_p diff --git a/django/contrib/gis/utils/srs.py b/django/contrib/gis/utils/srs.py index 07a593d90e8..fe2f291cb88 100644 --- a/django/contrib/gis/utils/srs.py +++ b/django/contrib/gis/utils/srs.py @@ -24,7 +24,7 @@ def add_srs_entry(srs, auth_name='EPSG', auth_srid=None, ref_sys_name=None, Defaults to the SRID determined by GDAL. ref_sys_name: - For SpatiaLite users only, sets the value of the the `ref_sys_name` field. + For SpatiaLite users only, sets the value of the `ref_sys_name` field. Defaults to the name determined by GDAL. database: diff --git a/django/contrib/staticfiles/views.py b/django/contrib/staticfiles/views.py index 85459812ad4..fe095ed2259 100644 --- a/django/contrib/staticfiles/views.py +++ b/django/contrib/staticfiles/views.py @@ -32,7 +32,7 @@ def serve(request, path, document_root=None, insecure=False, **kwargs): """ if not settings.DEBUG and not insecure: raise ImproperlyConfigured("The staticfiles view can only be used in " - "debug mode or if the the --insecure " + "debug mode or if the --insecure " "option of 'runserver' is used") normalized_path = posixpath.normpath(unquote(path)).lstrip('/') absolute_path = finders.find(normalized_path) diff --git a/django/db/models/query.py b/django/db/models/query.py index 68d7931729b..eda71d24784 100644 --- a/django/db/models/query.py +++ b/django/db/models/query.py @@ -1587,7 +1587,7 @@ def prefetch_related_objects(result_cache, related_lookups): continue done_lookups.add(lookup) - # Top level, the list of objects to decorate is the the result cache + # Top level, the list of objects to decorate is the result cache # from the primary QuerySet. It won't be for deeper levels. obj_list = result_cache diff --git a/django/middleware/csrf.py b/django/middleware/csrf.py index b2eb0df3f5f..339f42a1105 100644 --- a/django/middleware/csrf.py +++ b/django/middleware/csrf.py @@ -41,10 +41,10 @@ def _get_new_csrf_key(): def get_token(request): """ - Returns the the CSRF token required for a POST form. The token is an + Returns the CSRF token required for a POST form. The token is an alphanumeric value. - A side effect of calling this function is to make the the csrf_protect + A side effect of calling this function is to make the csrf_protect decorator and the CsrfViewMiddleware add a CSRF cookie and a 'Vary: Cookie' header to the outgoing response. For this reason, you may need to use this function lazily, as is done by the csrf context processor. diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt index 67dda02f8b3..bc2f97a4853 100644 --- a/docs/internals/contributing/committing-code.txt +++ b/docs/internals/contributing/committing-code.txt @@ -116,7 +116,7 @@ Practicality beats purity, so it is up to each committer to decide how much history mangling to do for a pull request. The main points are engaging the community, getting work done, and having a usable commit history. -.. _committing-guidlines: +.. _committing-guidelines: Committing guidelines --------------------- diff --git a/docs/internals/contributing/writing-code/working-with-git.txt b/docs/internals/contributing/writing-code/working-with-git.txt index d4a95ae45a1..dcfdd9e85ba 100644 --- a/docs/internals/contributing/writing-code/working-with-git.txt +++ b/docs/internals/contributing/writing-code/working-with-git.txt @@ -81,7 +81,7 @@ commit them:: git commit When writing the commit message, follow the :ref:`commit message -guidelines ` to ease the work of the committer. If +guidelines ` to ease the work of the committer. If you're uncomfortable with English, try at least to describe precisely what the commit does. @@ -121,7 +121,7 @@ a pull request at GitHub. A good pull request means: * well-formed messages for each commit: a summary line and then paragraphs wrapped at 72 characters thereafter -- see the :ref:`committing guidelines - ` for more details, + ` for more details, * documentation and tests, if needed -- actually tests are always needed, except for documentation changes. diff --git a/docs/intro/overview.txt b/docs/intro/overview.txt index 7cca8bf51b3..4f3cd473105 100644 --- a/docs/intro/overview.txt +++ b/docs/intro/overview.txt @@ -56,7 +56,9 @@ Enjoy the free API ================== With that, you've got a free, and rich, :doc:`Python API ` to -access your data. The API is created on the fly, no code generation necessary:: +access your data. The API is created on the fly, no code generation necessary: + +.. code-block:: python # Import the models we created from our "news" app >>> from news.models import Reporter, Article diff --git a/docs/misc/api-stability.txt b/docs/misc/api-stability.txt index 8ae3c716dfa..3c265be04f2 100644 --- a/docs/misc/api-stability.txt +++ b/docs/misc/api-stability.txt @@ -118,7 +118,8 @@ Security fixes If we become aware of a security problem -- hopefully by someone following our :ref:`security reporting policy ` -- we'll do -everything necessary to fix it. This might mean breaking backwards compatibility; security trumps the compatibility guarantee. +everything necessary to fix it. This might mean breaking backwards +compatibility; security trumps the compatibility guarantee. Contributed applications (``django.contrib``) --------------------------------------------- diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index a862d558757..1c19499d2a7 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -824,7 +824,7 @@ subclass:: added last after all editable fields. A read-only field can not only display data from a model's field, it can - also display the output of a a model's method or a method of the + also display the output of a model's method or a method of the ``ModelAdmin`` class itself. This is very similar to the way :attr:`ModelAdmin.list_display` behaves. This provides an easy way to use the admin interface to provide feedback on the status of the objects being diff --git a/docs/ref/contrib/gis/install/index.txt b/docs/ref/contrib/gis/install/index.txt index 35c01c9b7e3..2987539f337 100644 --- a/docs/ref/contrib/gis/install/index.txt +++ b/docs/ref/contrib/gis/install/index.txt @@ -330,7 +330,7 @@ described above, ``psycopg2`` may be installed using the following command:: .. note:: - If you don't have ``pip``, follow the the :ref:`installation instructions + If you don't have ``pip``, follow the :ref:`installation instructions ` to install it. .. _fink: diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt index 569738569d4..1a57770b2b7 100644 --- a/docs/topics/auth/default.txt +++ b/docs/topics/auth/default.txt @@ -82,7 +82,7 @@ Changing passwords Django does not store raw (clear text) passwords on the user model, but only a hash (see :doc:`documentation of how passwords are managed ` for full details). Because of this, do not attempt to -manipulate the password attribute of the user directly. This is why a a helper +manipulate the password attribute of the user directly. This is why a helper function is used when creating a user. To change a user's password, you have several options: diff --git a/tests/regressiontests/admin_views/tests.py b/tests/regressiontests/admin_views/tests.py index d7d01e6a92c..1633fba6b54 100644 --- a/tests/regressiontests/admin_views/tests.py +++ b/tests/regressiontests/admin_views/tests.py @@ -2454,7 +2454,7 @@ class TestCustomChangeList(TestCase): self.assertEqual(response.status_code, 302) # redirect somewhere # Hit the page once to get messages out of the queue message list response = self.client.get('/test_admin/%s/admin_views/gadget/' % self.urlbit) - # Ensure that that data is still not visible on the page + # Ensure that data is still not visible on the page response = self.client.get('/test_admin/%s/admin_views/gadget/' % self.urlbit) self.assertEqual(response.status_code, 200) self.assertNotContains(response, 'First Gadget') diff --git a/tests/regressiontests/builtin_server/tests.py b/tests/regressiontests/builtin_server/tests.py index c8dc77e42e2..041bb3c3199 100644 --- a/tests/regressiontests/builtin_server/tests.py +++ b/tests/regressiontests/builtin_server/tests.py @@ -7,7 +7,7 @@ from django.utils.unittest import TestCase # # Tests for #9659: wsgi.file_wrapper in the builtin server. -# We need to mock a couple of of handlers and keep track of what +# We need to mock a couple of handlers and keep track of what # gets called when using a couple kinds of WSGI apps. #