Fixed #21035 -- Changed docs to treat the acronym SQL phonetically.

The documentation and comments now all use 'an' to
refer to the word SQL and not 'a'.
This commit is contained in:
Eric Boersma 2013-09-05 18:23:48 -04:00 committed by Tim Graham
parent 93dd31cadf
commit 4d13cc56de
13 changed files with 19 additions and 15 deletions

View File

@ -22,6 +22,6 @@ class DistanceField(BaseField):
class GeomField(BaseField): class GeomField(BaseField):
""" """
Wrapper for Geometry values. It is a lightweight alternative to Wrapper for Geometry values. It is a lightweight alternative to
using GeometryField (which requires a SQL query upon instantiation). using GeometryField (which requires an SQL query upon instantiation).
""" """
pass pass

View File

@ -728,7 +728,7 @@ class BaseDatabaseOperations(object):
def cache_key_culling_sql(self): def cache_key_culling_sql(self):
""" """
Returns a SQL query that retrieves the first cache key greater than the Returns an SQL query that retrieves the first cache key greater than the
n smallest. n smallest.
This is used by the 'db' cache backend to determine where to start This is used by the 'db' cache backend to determine where to start
@ -960,7 +960,7 @@ class BaseDatabaseOperations(object):
def random_function_sql(self): def random_function_sql(self):
""" """
Returns a SQL expression that returns a random value. Returns an SQL expression that returns a random value.
""" """
return 'RANDOM()' return 'RANDOM()'

View File

@ -78,6 +78,10 @@ documentation:
* **MySQL**, **PostgreSQL**, **SQLite** * **MySQL**, **PostgreSQL**, **SQLite**
* **SQL** -- when referring to SQL, the expected pronunciation should be
"Ess Queue Ell" and not "sequel". Thus in a phrase like "Returns an
SQL expression", "SQL" should be preceded by "an" and not "a".
* **Python** -- when referring to the language, capitalize Python. * **Python** -- when referring to the language, capitalize Python.
* **realize**, **customize**, **initialize**, etc. -- use the American * **realize**, **customize**, **initialize**, etc. -- use the American

View File

@ -33,7 +33,7 @@ database to use. It automatically defaults to ``'template_postgis'``
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
When GeoDjango's spatial backend initializes on PostGIS, it has to perform When GeoDjango's spatial backend initializes on PostGIS, it has to perform
a SQL query to determine the version in order to figure out what an SQL query to determine the version in order to figure out what
features are available. Advanced users wishing to prevent this additional features are available. Advanced users wishing to prevent this additional
query may set the version manually using a 3-tuple of integers specifying query may set the version manually using a 3-tuple of integers specifying
the major, minor, and subminor version numbers for PostGIS. For example, the major, minor, and subminor version numbers for PostGIS. For example,

View File

@ -635,7 +635,7 @@ Parameters not quoted in ``connection.queries``
``sqlite3`` does not provide a way to retrieve the SQL after quoting and ``sqlite3`` does not provide a way to retrieve the SQL after quoting and
substituting the parameters. Instead, the SQL in ``connection.queries`` is substituting the parameters. Instead, the SQL in ``connection.queries`` is
rebuilt with a simple string interpolation. It may be incorrect. Make sure rebuilt with a simple string interpolation. It may be incorrect. Make sure
you add quotes where necessary before copying a query into a SQLite shell. you add quotes where necessary before copying a query into an SQLite shell.
.. _oracle-notes: .. _oracle-notes:

View File

@ -1519,7 +1519,7 @@ number of roles in which color is used:
* ``notice`` - A minor error. * ``notice`` - A minor error.
* ``sql_field`` - The name of a model field in SQL. * ``sql_field`` - The name of a model field in SQL.
* ``sql_coltype`` - The type of a model field in SQL. * ``sql_coltype`` - The type of a model field in SQL.
* ``sql_keyword`` - A SQL keyword. * ``sql_keyword`` - An SQL keyword.
* ``sql_table`` - The name of a model in SQL. * ``sql_table`` - The name of a model in SQL.
* ``http_info`` - A 1XX HTTP Informational server response. * ``http_info`` - A 1XX HTTP Informational server response.
* ``http_success`` - A 2XX HTTP Success server response. * ``http_success`` - A 2XX HTTP Success server response.

View File

@ -1175,7 +1175,7 @@ The possible values for :attr:`~ForeignKey.on_delete` are found in
Take no action. If your database backend enforces referential Take no action. If your database backend enforces referential
integrity, this will cause an :exc:`~django.db.IntegrityError` unless integrity, this will cause an :exc:`~django.db.IntegrityError` unless
you manually add a SQL ``ON DELETE`` constraint to the database field you manually add an SQL ``ON DELETE`` constraint to the database field
(perhaps using :ref:`initial sql<initial-sql>`). (perhaps using :ref:`initial sql<initial-sql>`).
.. _ref-manytomany: .. _ref-manytomany:

View File

@ -417,7 +417,7 @@ Deleting objects
.. method:: Model.delete([using=DEFAULT_DB_ALIAS]) .. method:: Model.delete([using=DEFAULT_DB_ALIAS])
Issues a SQL ``DELETE`` for the object. This only deletes the object in the Issues an SQL ``DELETE`` for the object. This only deletes the object in the
database; the Python instance will still exist and will still have data in database; the Python instance will still exist and will still have data in
its fields. its fields.

View File

@ -802,7 +802,7 @@ This has a similar purpose to ``select_related``, in that both are designed to
stop the deluge of database queries that is caused by accessing related objects, stop the deluge of database queries that is caused by accessing related objects,
but the strategy is quite different. but the strategy is quite different.
``select_related`` works by creating a SQL join and including the fields of the ``select_related`` works by creating an SQL join and including the fields of the
related object in the ``SELECT`` statement. For this reason, ``select_related`` related object in the ``SELECT`` statement. For this reason, ``select_related``
gets the related objects in the same database query. However, to avoid the much gets the related objects in the same database query. However, to avoid the much
larger result set that would result from joining across a 'many' relationship, larger result set that would result from joining across a 'many' relationship,
@ -932,7 +932,7 @@ referenced is needed, rather than one query for all the items. There could be
additional queries on the ``ContentType`` table if the relevant rows have not additional queries on the ``ContentType`` table if the relevant rows have not
already been fetched. already been fetched.
``prefetch_related`` in most cases will be implemented using a SQL query that ``prefetch_related`` in most cases will be implemented using an SQL query that
uses the 'IN' operator. This means that for a large ``QuerySet`` a large 'IN' clause uses the 'IN' operator. This means that for a large ``QuerySet`` a large 'IN' clause
could be generated, which, depending on the database, might have performance could be generated, which, depending on the database, might have performance
problems of its own when it comes to parsing or executing the SQL query. Always problems of its own when it comes to parsing or executing the SQL query. Always

View File

@ -83,6 +83,6 @@ Other bugfixes and changes
========================== ==========================
* Prevented transaction state from leaking from one request to the next (#19707). * Prevented transaction state from leaking from one request to the next (#19707).
* Changed a SQL command syntax to be MySQL 4 compatible (#19702). * Changed an SQL command syntax to be MySQL 4 compatible (#19702).
* Added backwards-compatibility with old unsalted MD5 passwords (#18144). * Added backwards-compatibility with old unsalted MD5 passwords (#18144).
* Numerous documentation improvements and fixes. * Numerous documentation improvements and fixes.

View File

@ -442,7 +442,7 @@ Consider the following example::
In statement 1, a new ``Person`` object is saved to the ``first`` In statement 1, a new ``Person`` object is saved to the ``first``
database. At this time, ``p`` doesn't have a primary key, so Django database. At this time, ``p`` doesn't have a primary key, so Django
issues a SQL ``INSERT`` statement. This creates a primary key, and issues an SQL ``INSERT`` statement. This creates a primary key, and
Django assigns that primary key to ``p``. Django assigns that primary key to ``p``.
When the save occurs in statement 2, ``p`` already has a primary key When the save occurs in statement 2, ``p`` already has a primary key
@ -466,7 +466,7 @@ database::
>>> p.save(using='second') # Write a completely new object. >>> p.save(using='second') # Write a completely new object.
The second option is to use the ``force_insert`` option to ``save()`` The second option is to use the ``force_insert`` option to ``save()``
to ensure that Django does a SQL ``INSERT``:: to ensure that Django does an SQL ``INSERT``::
>>> p = Person(name='Fred') >>> p = Person(name='Fred')
>>> p.save(using='first') >>> p.save(using='first')

View File

@ -403,7 +403,7 @@ class EscapingChecks(TestCase):
self.assertEqual(cursor.fetchall()[0], ('%', '%d')) self.assertEqual(cursor.fetchall()[0], ('%', '%d'))
@unittest.skipUnless(connection.vendor == 'sqlite', @unittest.skipUnless(connection.vendor == 'sqlite',
"This is a sqlite-specific issue") "This is an sqlite-specific issue")
def test_sqlite_parameter_escaping(self): def test_sqlite_parameter_escaping(self):
#13648: '%s' escaping support for sqlite3 #13648: '%s' escaping support for sqlite3
cursor = connection.cursor() cursor = connection.cursor()

View File

@ -246,7 +246,7 @@ class Sqlite3InMemoryTestDbs(TestCase):
available_apps = [] available_apps = []
@unittest.skipUnless(all(db.connections[conn].vendor == 'sqlite' for conn in db.connections), @unittest.skipUnless(all(db.connections[conn].vendor == 'sqlite' for conn in db.connections),
"This is a sqlite-specific issue") "This is an sqlite-specific issue")
def test_transaction_support(self): def test_transaction_support(self):
"""Ticket #16329: sqlite3 in-memory test databases""" """Ticket #16329: sqlite3 in-memory test databases"""
old_db_connections = db.connections old_db_connections = db.connections