From: Matthias Urlichs <matthias@urlichs.de>
Date: Sun, 11 May 2014 14:49:56 +0000 (+0200)
Subject: Documentation fix-up: "its" vs. "it's"
X-Git-Tag: rel_0_8_7~32
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3b936983deaf55563081548ac7463f9aa31c1506;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

Documentation fix-up: "its" vs. "it's"

Removed ungrammatical apostrophes from documentation, replacing
"it's" with "its" where appropriate (but in a few cases with "it is"
when that read better).

While doing that, I also fixed a couple of minor typos etc.
as I noticed them.
---

diff --git a/doc/build/changelog/changelog_05.rst b/doc/build/changelog/changelog_05.rst
index 96a0fb19f9..04ab11dca5 100644
--- a/doc/build/changelog/changelog_05.rst
+++ b/doc/build/changelog/changelog_05.rst
@@ -1557,7 +1557,7 @@
         :tickets: 
 
       Column with no name (as in declarative) won't raise a
-      NoneType error when it's string output is requsted
+      NoneType error when its string output is requested
       (such as in a stack trace).
 
     .. change::
diff --git a/doc/build/changelog/changelog_07.rst b/doc/build/changelog/changelog_07.rst
index d6fe4af906..5504a0ad67 100644
--- a/doc/build/changelog/changelog_07.rst
+++ b/doc/build/changelog/changelog_07.rst
@@ -4084,7 +4084,7 @@
 
       The Column.references() method now returns True
       if it has a foreign key referencing the
-      given column exactly, not just it's parent
+      given column exactly, not just its parent
       table.
 
     .. change::
diff --git a/doc/build/changelog/migration_05.rst b/doc/build/changelog/migration_05.rst
index c79f8b0f62..01ceef1c6e 100644
--- a/doc/build/changelog/migration_05.rst
+++ b/doc/build/changelog/migration_05.rst
@@ -338,7 +338,7 @@ extend the ORM.  Heres a summary:
 * **SessionExtension.** - This is an easy to use extension
   class for session events.  In particular, it provides
   ``before_flush()``, ``after_flush()`` and
-  ``after_flush_postexec()`` methods.  It's usage is
+  ``after_flush_postexec()`` methods.  This usage is
   recommended over ``MapperExtension.before_XXX`` in many
   cases since within ``before_flush()`` you can modify the
   flush plan of the session freely, something which cannot
@@ -545,7 +545,7 @@ Removed
 * **get()/load() cleanup**
 
 
-  The ``load()`` method has been removed.  It's
+  The ``load()`` method has been removed.  Its
   functionality was kind of arbitrary and basically copied
   from Hibernate, where it's also not a particularly
   meaningful method.
diff --git a/doc/build/changelog/migration_08.rst b/doc/build/changelog/migration_08.rst
index e6f2008d5a..3346916ea6 100644
--- a/doc/build/changelog/migration_08.rst
+++ b/doc/build/changelog/migration_08.rst
@@ -632,7 +632,7 @@ not really a column, CAST operator, or SQL function that
 really drives what kinds of operations are present, it's the
 *type* of the expression.   The implementation details are
 minimal - only a few extra methods are added to the core
-:class:`.ColumnElement` type so that it consults it's
+:class:`.ColumnElement` type so that it consults its
 :class:`.TypeEngine` object for an optional set of operators.
 New or revised operations can be associated with any type,
 either via subclassing of an existing type, by using
diff --git a/doc/build/core/pooling.rst b/doc/build/core/pooling.rst
index 550fb35274..89fa23fb6a 100644
--- a/doc/build/core/pooling.rst
+++ b/doc/build/core/pooling.rst
@@ -127,7 +127,7 @@ within a transparent proxy::
     cursor.execute("select foo")
 
 The purpose of the transparent proxy is to intercept the ``close()`` call,
-such that instead of the DBAPI connection being closed, it's returned to the
+such that instead of the DBAPI connection being closed, it is returned to the
 pool::
 
     # "close" the connection.  Returns
@@ -229,7 +229,7 @@ Disconnect Handling - Pessimistic
 
 At the expense of some extra SQL emitted for each connection checked out from the pool,
 a "ping" operation established by a checkout event handler
-can detect an invalid connection before it's used::
+can detect an invalid connection before it is used::
 
     from sqlalchemy import exc
     from sqlalchemy import event
diff --git a/doc/build/orm/relationships.rst b/doc/build/orm/relationships.rst
index 37a7548d67..195f564e6a 100644
--- a/doc/build/orm/relationships.rst
+++ b/doc/build/orm/relationships.rst
@@ -1012,7 +1012,7 @@ to just ``city='Boston'``.   When using Declarative, rudimentary SQL functions l
 
 The custom criteria we use in a :paramref:`~.relationship.primaryjoin`
 is generally only significant when SQLAlchemy is rendering SQL in
-order to load or represent this relationship. That is, it's  used in
+order to load or represent this relationship. That is, it's used in
 the SQL statement that's emitted in order to perform a per-attribute
 lazy load, or when a join is constructed at query time, such as via
 :meth:`.Query.join`, or via the eager "joined" or "subquery" styles of
diff --git a/doc/build/orm/session.rst b/doc/build/orm/session.rst
index 3efeab9285..ba3049b756 100644
--- a/doc/build/orm/session.rst
+++ b/doc/build/orm/session.rst
@@ -663,8 +663,8 @@ new session. Here's some examples:
   copies of itself that are local to individual :class:`~.Session`
   objects.
 
-  In the caching use case, it's common that the ``load=False`` flag
-  is used to remove the overhead of reconciling the object's state
+  In the caching use case, it's common to use the ``load=False``
+  flag to remove the overhead of reconciling the object's state
   with the database.   There's also a "bulk" version of
   :meth:`~.Session.merge` called :meth:`~.Query.merge_result`
   that was designed to work with cache-extended :class:`.Query`
@@ -1713,7 +1713,7 @@ Using Subtransactions with Autocommit
 A subtransaction indicates usage of the :meth:`.Session.begin` method in conjunction with
 the ``subtransactions=True`` flag.  This produces a non-transactional, delimiting construct that
 allows nesting of calls to :meth:`~.Session.begin` and :meth:`~.Session.commit`.
-It's purpose is to allow the construction of code that can function within a transaction
+Its purpose is to allow the construction of code that can function within a transaction
 both independently of any external code that starts a transaction,
 as well as within a block that has already demarcated a transaction.
 
diff --git a/lib/sqlalchemy/dialects/mssql/base.py b/lib/sqlalchemy/dialects/mssql/base.py
index a4502a5bf6..de61b8f1a3 100644
--- a/lib/sqlalchemy/dialects/mssql/base.py
+++ b/lib/sqlalchemy/dialects/mssql/base.py
@@ -713,7 +713,7 @@ class MSSQLCompiler(compiler.SQLCompiler):
                                         self.process(binary.right, **kw))
 
     def get_select_precolumns(self, select):
-        """ MS-SQL puts TOP, it's version of LIMIT here """
+        """ MS-SQL puts TOP, its version of LIMIT, here """
         if select._distinct or select._limit is not None:
             s = select._distinct and "DISTINCT " or ""
 
diff --git a/lib/sqlalchemy/dialects/oracle/cx_oracle.py b/lib/sqlalchemy/dialects/oracle/cx_oracle.py
index 5e04abb267..4fabf220c5 100644
--- a/lib/sqlalchemy/dialects/oracle/cx_oracle.py
+++ b/lib/sqlalchemy/dialects/oracle/cx_oracle.py
@@ -417,7 +417,7 @@ class OracleExecutionContext_cx_oracle(OracleExecutionContext):
                     if dbtype is None:
                         raise exc.InvalidRequestError(
                                     "Cannot create out parameter for parameter "
-                                    "%r - it's type %r is not supported by"
+                                    "%r - its type %r is not supported by"
                                     " cx_oracle" %
                                     (bindparam.key, bindparam.type)
                                     )
diff --git a/lib/sqlalchemy/dialects/type_migration_guidelines.txt b/lib/sqlalchemy/dialects/type_migration_guidelines.txt
index 1ca15f7fb1..2d06cf6979 100644
--- a/lib/sqlalchemy/dialects/type_migration_guidelines.txt
+++ b/lib/sqlalchemy/dialects/type_migration_guidelines.txt
@@ -114,7 +114,7 @@ linked to TypeEngine classes.
 
     a. The string name should be matched to the most specific type possible within
     sqlalchemy.types, unless there is no matching type within sqlalchemy.types in which
-    case it points to a dialect type.   *It doesn't matter* if the dialect has it's 
+    case it points to a dialect type.   *It doesn't matter* if the dialect has its 
     own subclass of that type with special bind/result behavior - reflect to the types.py
     UPPERCASE type as much as possible.   With very few exceptions, all types
     should reflect to an UPPERCASE type.
diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py
index 48e5f4582c..5b03e89c2a 100644
--- a/lib/sqlalchemy/engine/__init__.py
+++ b/lib/sqlalchemy/engine/__init__.py
@@ -9,7 +9,7 @@
 The engine package defines the basic components used to interface
 DB-API modules with higher-level statement construction,
 connection-management, execution and result contexts.  The primary
-"entry point" class into this package is the Engine and it's public
+"entry point" class into this package is the Engine and its public
 constructor ``create_engine()``.
 
 This package includes:
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 860649130c..463b371252 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -115,7 +115,7 @@ class Connection(Connectable):
         execution options which will take effect for a call to
         :meth:`execute`. As the new :class:`.Connection` references the same
         underlying resource, it's usually a good idea to ensure that the copies
-        would be discarded immediately, which is implicit if used as in::
+        will be discarded immediately, which is implicit if used as in::
 
             result = connection.execution_options(stream_results=True).\\
                                 execute(stmt)
diff --git a/lib/sqlalchemy/ext/compiler.py b/lib/sqlalchemy/ext/compiler.py
index 5835226648..77ce60dbac 100644
--- a/lib/sqlalchemy/ext/compiler.py
+++ b/lib/sqlalchemy/ext/compiler.py
@@ -319,7 +319,7 @@ Example usage::
 -------------------
 
 The "GREATEST" function is given any number of arguments and returns the one
-that is of the highest value - it's equivalent to Python's ``max``
+that is of the highest value - its equivalent to Python's ``max``
 function.  A SQL standard version versus a CASE based version which only
 accommodates two arguments::
 
diff --git a/lib/sqlalchemy/orm/collections.py b/lib/sqlalchemy/orm/collections.py
index 9676c586d8..62689244ed 100644
--- a/lib/sqlalchemy/orm/collections.py
+++ b/lib/sqlalchemy/orm/collections.py
@@ -446,7 +446,7 @@ class collection(object):
         The converter method will receive the object being assigned and should
         return an iterable of values suitable for use by the ``appender``
         method.  A converter must not assign values or mutate the collection,
-        it's sole job is to adapt the value the user provides into an iterable
+        its sole job is to adapt the value the user provides into an iterable
         of values for the ORM's use.
 
         The default converter implementation will use duck-typing to do the
diff --git a/lib/sqlalchemy/orm/deprecated_interfaces.py b/lib/sqlalchemy/orm/deprecated_interfaces.py
index 619863905a..f232dbb815 100644
--- a/lib/sqlalchemy/orm/deprecated_interfaces.py
+++ b/lib/sqlalchemy/orm/deprecated_interfaces.py
@@ -127,7 +127,7 @@ class MapperExtension(object):
         return EXT_CONTINUE
 
     def init_instance(self, mapper, class_, oldinit, instance, args, kwargs):
-        """Receive an instance when it's constructor is called.
+        """Receive an instance when its constructor is called.
 
         This method is only called during a userland construction of
         an object.  It is not called when an object is loaded from the
@@ -140,7 +140,7 @@ class MapperExtension(object):
         return EXT_CONTINUE
 
     def init_failed(self, mapper, class_, oldinit, instance, args, kwargs):
-        """Receive an instance when it's constructor has been called,
+        """Receive an instance when its constructor has been called,
         and raised an exception.
 
         This method is only called during a userland construction of
diff --git a/lib/sqlalchemy/orm/events.py b/lib/sqlalchemy/orm/events.py
index 58e17acaa2..9142903f7c 100644
--- a/lib/sqlalchemy/orm/events.py
+++ b/lib/sqlalchemy/orm/events.py
@@ -198,7 +198,7 @@ class InstanceEvents(event.Events):
         """
 
     def init(self, target, args, kwargs):
-        """Receive an instance when it's constructor is called.
+        """Receive an instance when its constructor is called.
 
         This method is only called during a userland construction of
         an object.  It is not called when an object is loaded from the
@@ -207,7 +207,7 @@ class InstanceEvents(event.Events):
         """
 
     def init_failure(self, target, args, kwargs):
-        """Receive an instance when it's constructor has been called,
+        """Receive an instance when its constructor has been called,
         and raised an exception.
 
         This method is only called during a userland construction of
@@ -301,7 +301,7 @@ class InstanceEvents(event.Events):
         """
 
     def unpickle(self, target, state_dict):
-        """Receive an object instance after it's associated state has
+        """Receive an object instance after its associated state has
         been unpickled.
 
         :param target: the mapped instance.  If
diff --git a/lib/sqlalchemy/sql/functions.py b/lib/sqlalchemy/sql/functions.py
index db97794eca..d5c3b1cff2 100644
--- a/lib/sqlalchemy/sql/functions.py
+++ b/lib/sqlalchemy/sql/functions.py
@@ -135,7 +135,7 @@ register_function("extract", extract)
 
 class next_value(GenericFunction):
     """Represent the 'next value', given a :class:`.Sequence`
-    as it's single argument.
+    as its single argument.
 
     Compiles into the appropriate function on each backend,
     or will raise NotImplementedError if used on a backend
diff --git a/test/aaa_profiling/test_memusage.py b/test/aaa_profiling/test_memusage.py
index 659af3a94c..b47a5d7eda 100644
--- a/test/aaa_profiling/test_memusage.py
+++ b/test/aaa_profiling/test_memusage.py
@@ -318,7 +318,7 @@ class MemUsageTest(EnsureZeroed):
         i = [1]
 
         # the times here is cranked way up so that we can see
-        # pysqlite clearing out it's internal buffer and allow
+        # pysqlite clearing out its internal buffer and allow
         # the test to pass
         @testing.emits_warning()
         @profile_memory()