From ba1728dd9b19088c0c37253a938a6d97c61d5ed6 Mon Sep 17 00:00:00 2001 From: Marti Raudsepp Date: Wed, 23 Apr 2014 02:05:14 +0300 Subject: [PATCH] [1.7.x] Various documentation typo/spelling fixes Errors detected by Topy (https://github.com/intgr/topy), all changes verified by hand. Backport of 11d453bcad from master --- docs/internals/committers.txt | 4 ++-- docs/internals/contributing/writing-code/coding-style.txt | 2 +- docs/internals/contributing/writing-documentation.txt | 2 +- docs/ref/contrib/admin/actions.txt | 2 +- docs/ref/contrib/formtools/form-wizard.txt | 2 +- docs/ref/contrib/gis/gdal.txt | 2 +- docs/ref/contrib/gis/geos.txt | 2 +- docs/ref/databases.txt | 2 +- docs/ref/migration-operations.txt | 2 +- docs/ref/utils.txt | 2 +- docs/releases/1.0-alpha-1.txt | 2 +- docs/releases/1.1.txt | 2 +- docs/releases/1.2-alpha-1.txt | 2 +- docs/releases/1.6.4.txt | 2 +- docs/spelling_wordlist | 1 - docs/topics/forms/index.txt | 2 +- docs/topics/i18n/translation.txt | 2 +- docs/topics/testing/advanced.txt | 2 +- 18 files changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/internals/committers.txt b/docs/internals/committers.txt index 1122130a58..d32e65d314 100644 --- a/docs/internals/committers.txt +++ b/docs/internals/committers.txt @@ -310,7 +310,7 @@ Ramiro Morales Honza Král Honza first discovered Django in 2006 and started using it right away, - first for school and personal projects and later in his full time job. He + first for school and personal projects and later in his full-time job. He contributed various patches and fixes mostly to the newforms library, newforms admin and, through participation in the Google Summer of Code project, assisted in creating the :ref:`model validation @@ -510,7 +510,7 @@ Marc Tamlyn documentation at DjangoCon EU 2012, and also helped to develop `CCBV`_, an additional class based view reference tool. - Marc is currently a full time parent, part time developer, and lives in + Marc is currently a full-time parent, part-time developer, and lives in Oxford, UK. .. _CCBV: http://ccbv.co.uk/ diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index b0004bd979..9ff58e8b30 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -206,7 +206,7 @@ Miscellaneous * Remove ``import`` statements that are no longer used when you change code. `flake8`_ will identify these imports for you. If an unused import needs to - remain for backwards-compatibility, mark the end of of with ``# NOQA`` to + remain for backwards-compatibility, mark the end of with ``# NOQA`` to silence the flake8 warning. * Systematically remove all trailing whitespaces from your code as those diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 2ceef3d05d..fcefbdccae 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -205,7 +205,7 @@ Our policy for new features is: release, not the development version. Our preferred way for marking new features is by prefacing the features' -documentation with: "``.. versionadded:: X.Y``", followed by a a mandatory +documentation with: "``.. versionadded:: X.Y``", followed by a mandatory blank line and an optional content (indented). General improvements, or other changes to the APIs that should be emphasized diff --git a/docs/ref/contrib/admin/actions.txt b/docs/ref/contrib/admin/actions.txt index a892f41106..5757e2e39b 100644 --- a/docs/ref/contrib/admin/actions.txt +++ b/docs/ref/contrib/admin/actions.txt @@ -145,7 +145,7 @@ Handling errors in actions If there are foreseeable error conditions that may occur while running your action, you should gracefully inform the user of the problem. This means -handling exceptions and and using +handling exceptions and using :meth:`django.contrib.admin.ModelAdmin.message_user` to display a user friendly description of the problem in the response. diff --git a/docs/ref/contrib/formtools/form-wizard.txt b/docs/ref/contrib/formtools/form-wizard.txt index 62f0eedd05..7db9689f06 100644 --- a/docs/ref/contrib/formtools/form-wizard.txt +++ b/docs/ref/contrib/formtools/form-wizard.txt @@ -106,7 +106,7 @@ respectively). in the :doc:`sessions documentation ` on how to enable sessions. -We will use the :class:`SessionWizardView` in all examples but is is completely +We will use the :class:`SessionWizardView` in all examples but is completely fine to use the :class:`CookieWizardView` instead. As with your :class:`~django.forms.Form` classes, this :class:`WizardView` class can live anywhere in your codebase, but convention is to put it in :file:`views.py`. diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt index 0dfcc520e6..009cc0b099 100644 --- a/docs/ref/contrib/gis/gdal.txt +++ b/docs/ref/contrib/gis/gdal.txt @@ -739,7 +739,7 @@ systems and coordinate transformation:: .. attribute:: z Returns the Z coordinate of this point, or ``None`` if the - the point does not have a Z coordinate:: + point does not have a Z coordinate:: >>> OGRGeometry('POINT (1 2 3)').z 3.0 diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index e316841f49..028b70e5d5 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -880,7 +880,7 @@ Returns WKB of the geometry in hexadecimal. Example:: .. attribute:: WKBWriter.byteorder -This property may be be set to change the byte-order of the geometry +This property may be set to change the byte-order of the geometry representation. =============== ================================================= diff --git a/docs/ref/databases.txt b/docs/ref/databases.txt index 3ed0cda40f..7ccba91d12 100644 --- a/docs/ref/databases.txt +++ b/docs/ref/databases.txt @@ -793,7 +793,7 @@ Threaded option ---------------- If you plan to run Django in a multithreaded environment (e.g. Apache using the -the default MPM module on any modern operating system), then you **must** set +default MPM module on any modern operating system), then you **must** set the ``threaded`` option of your Oracle database configuration to True:: 'OPTIONS': { diff --git a/docs/ref/migration-operations.txt b/docs/ref/migration-operations.txt index bbce6df861..2a5f46a93c 100644 --- a/docs/ref/migration-operations.txt +++ b/docs/ref/migration-operations.txt @@ -174,7 +174,7 @@ RunSQL RunSQL(sql, reverse_sql=None, state_operations=None, multiple=False) -Allows runnning of arbitrary SQL on the database - useful for more advanced +Allows running of arbitrary SQL on the database - useful for more advanced features of database backends that Django doesn't support directly, like partial indexes. diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index 5515c01a20..056f851003 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -1025,7 +1025,7 @@ For a complete discussion on the usage of the following see the current point in time. Exactly what's returned depends on the value of :setting:`USE_TZ`: - * If :setting:`USE_TZ` is ``False``, this will be be a + * If :setting:`USE_TZ` is ``False``, this will be a :ref:`naive ` datetime (i.e. a datetime without an associated timezone) that represents the current time in the system's local timezone. diff --git a/docs/releases/1.0-alpha-1.txt b/docs/releases/1.0-alpha-1.txt index 56ff5f8a4d..0660f9e5f7 100644 --- a/docs/releases/1.0-alpha-1.txt +++ b/docs/releases/1.0-alpha-1.txt @@ -77,7 +77,7 @@ handlers have been refactored to allow finer-grained control over the uploading process as well as streaming uploads of large files. Along with these improvements and additions, we've made a number of -of backwards-incompatible changes to the framework, as features have been +backwards-incompatible changes to the framework, as features have been fleshed out and APIs have been finalized for the 1.0 release. A complete guide to these changes will be available as part of the final Django 1.0 release, and a comprehensive list of backwards-incompatible diff --git a/docs/releases/1.1.txt b/docs/releases/1.1.txt index e3ee9428bf..3ea25e6704 100644 --- a/docs/releases/1.1.txt +++ b/docs/releases/1.1.txt @@ -50,7 +50,7 @@ Following this change, all platforms, regardless of word size, will generate a As a result of this change, you will not be able to use the ``reset`` management command on any table made by a 64-bit machine. This is because the -the new generated name will not match the historically generated name; as a +new generated name will not match the historically generated name; as a result, the SQL constructed by the reset command will be invalid. If you need to reset an application that was created with 64-bit constraints, diff --git a/docs/releases/1.2-alpha-1.txt b/docs/releases/1.2-alpha-1.txt index 8c905f6ef0..0d08c979ce 100644 --- a/docs/releases/1.2-alpha-1.txt +++ b/docs/releases/1.2-alpha-1.txt @@ -520,7 +520,7 @@ Added ``readonly_fields`` to ``ModelAdmin`` :attr:`django.contrib.admin.ModelAdmin.readonly_fields` has been added to enable non-editable fields in add/change pages for models and inlines. Field -and calculated values can be displayed along side editable fields. +and calculated values can be displayed alongside editable fields. Customizable syntax highlighting -------------------------------- diff --git a/docs/releases/1.6.4.txt b/docs/releases/1.6.4.txt index 8a325c9141..6bf0b6fef0 100644 --- a/docs/releases/1.6.4.txt +++ b/docs/releases/1.6.4.txt @@ -10,5 +10,5 @@ Bugfixes ======== * Added backwards compatibility support for the :mod:`django.contrib.messages` - cookie format of Django 1.4 and earlier to faciliate upgrading to 1.6 from + cookie format of Django 1.4 and earlier to facilitate upgrading to 1.6 from 1.4 (`#22426 `_). diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 615469c72c..a0ec39109c 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -506,7 +506,6 @@ roadmap Roald rss runfcgi -runnning runserver safeseq Sandvik diff --git a/docs/topics/forms/index.txt b/docs/topics/forms/index.txt index 441ab2eea3..3ccafcb192 100644 --- a/docs/topics/forms/index.txt +++ b/docs/topics/forms/index.txt @@ -96,7 +96,7 @@ The standard pattern for processing a form in a view looks like this: def contact(request): if request.method == 'POST': # If the form has been submitted... - # ContactForm was defined in the the previous section + # ContactForm was defined in the previous section form = ContactForm(request.POST) # A form bound to the POST data if form.is_valid(): # All validation rules pass # Process the data in form.cleaned_data diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt index 6d2280c839..794d66a21b 100644 --- a/docs/topics/i18n/translation.txt +++ b/docs/topics/i18n/translation.txt @@ -124,7 +124,7 @@ specified with Python's standard named-string interpolation syntax. Example:: This technique lets language-specific translations reorder the placeholder text. For example, an English translation may be ``"Today is November 26."``, while a Spanish translation may be ``"Hoy es 26 de Noviembre."`` -- with the -the month and the day placeholders swapped. +month and the day placeholders swapped. For this reason, you should use named-string interpolation (e.g., ``%(day)s``) instead of positional interpolation (e.g., ``%s`` or ``%d``) whenever you diff --git a/docs/topics/testing/advanced.txt b/docs/topics/testing/advanced.txt index 1bd15bd1a6..9e32120be7 100644 --- a/docs/topics/testing/advanced.txt +++ b/docs/topics/testing/advanced.txt @@ -51,7 +51,7 @@ The following is a simple unit test using the request factory:: # Create an instance of a GET request. request = self.factory.get('/customer/details') - # Recall that middleware are not suported. You can simulate a + # Recall that middleware are not supported. You can simulate a # logged-in user by setting request.user manually. request.user = self.user