]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
fix: typos in doc/build/orm (#7003)
authorKevin Kirsche <kevin.kirsche@one.verizon.com>
Wed, 8 Sep 2021 19:14:31 +0000 (15:14 -0400)
committerGitHub <noreply@github.com>
Wed, 8 Sep 2021 19:14:31 +0000 (21:14 +0200)
* fix: typos in doc/build/orm

* though -> through

Change-Id: I785336056497a4ac17f2d494f6d9cf913c12b024

Co-authored-by: Federico Caselli <cfederico87@gmail.com>
doc/build/orm/basic_relationships.rst
doc/build/orm/cascades.rst
doc/build/orm/extensions/asyncio.rst
doc/build/orm/extensions/mypy.rst
doc/build/orm/loading_objects.rst
doc/build/orm/session_basics.rst
doc/build/orm/session_transaction.rst

index bb790d991485bc81b1fcc7993ce0f32795c60fcb..40b3590b6fa67ae4df090aae2d51e187047b5d22 100644 (file)
@@ -655,7 +655,7 @@ that will be passed to ``eval()`` are:
 .. versionchanged:: 1.3.16
 
     Prior to SQLAlchemy 1.3.16, the main :paramref:`_orm.relationship.argument`
-    to :func:`_orm.relationship` was also evaluated throught ``eval()``   As of
+    to :func:`_orm.relationship` was also evaluated through ``eval()``   As of
     1.3.16 the string name is resolved from the class resolver directly without
     supporting custom Python expressions.
 
index 1f438035f68000dac12b0f484beea65e28d31424..1a2a7804c2100d07b547c32873a511fab116c6d7 100644 (file)
@@ -262,7 +262,7 @@ rules it will also delete all related ``Child`` rows.
     relationships, then the cascade action would continue cascading through all
     ``Parent`` and ``Child`` objects, loading each ``children`` and ``parents``
     collection encountered and deleting everything that's connected.   It is
-    typically not desireable for "delete" cascade to be configured
+    typically not desirable for "delete" cascade to be configured
     bidirectionally.
 
 .. seealso::
index f3e89c647a640f47b01ac1284fb99f79b2d5c9c5..5c833e4e49482a87f733960e6335b3de03c0c1fe 100644 (file)
@@ -463,7 +463,7 @@ Using asyncio scoped session
 
 The usage of :class:`_asyncio.async_scoped_session` is mostly similar to
 :class:`.scoped_session`. However, since there's no "thread-local" concept in
-the asyncio context, the "scopefunc" paramater must be provided to the
+the asyncio context, the "scopefunc" parameter must be provided to the
 constructor::
 
     from asyncio import current_task
index edd3af7c0a278267bd70681df5ccde9a3687d2b7..b710d1f4430ee2c3acda12914a4a268384fc5f89 100644 (file)
@@ -379,7 +379,7 @@ a collection annotation such as ``List`` may be used.   It is also fully
 appropriate to use the string name of the class in the annotation as supported
 by pep-484, ensuring the class is imported with in
 the `TYPE_CHECKING block <https://www.python.org/dev/peps/pep-0484/#runtime-or-type-checking>`_
-as approriate::
+as appropriate::
 
     from typing import List, TYPE_CHECKING
     from .mymodel import Base
@@ -548,4 +548,4 @@ This attribute can be conditional within the ``TYPE_CHECKING`` variable::
 With the above recipe, the attributes listed in ``_mypy_mapped_attrs``
 will be applied with the :class:`_orm.Mapped` typing information so that the
 ``User`` class will behave as a SQLAlchemy mapped class when used in a
-class-bound context.
\ No newline at end of file
+class-bound context.
index 3075ea9f4ee75ce0fc078b8c2e2383a57d6cdc2a..956ef2f6995587f704c20c9bacc6cf7c24ee69b5 100644 (file)
@@ -8,7 +8,7 @@ ORM mapped objects, but also involves calling forms that deliver individual
 column or groups of columns as well.
 
 For an introduction to querying with the SQLAlchemy ORM, one of the
-following tutorials shoud be consulted:
+following tutorials should be consulted:
 
 * :doc:`/tutorial/index` - for :term:`2.0 style` usage
 
index d53b16074ef71f102d5a4155bbd809c8c062af89..529f786c1afe8693ae12afe46b1990e22177a8be 100644 (file)
@@ -536,7 +536,7 @@ UPDATE and DELETE with arbitrary WHERE clause
 The sections above on :meth:`_orm.Session.flush` and :meth:`_orm.Session.delete`
 detail how rows can be inserted, updated and deleted in the database,
 based on primary key identities that are referred towards by mapped Python
-objets in the application.   The :class:`_orm.Session` can also emit UPDATE
+objects in the application.   The :class:`_orm.Session` can also emit UPDATE
 and DELETE statements with arbitrary WHERE clauses as well, and at the same
 time refresh locally present objects which match those rows.
 
@@ -617,7 +617,7 @@ values for ``synchronize_session`` are supported:
 * ``'evaluate'`` - Evaluate the WHERE criteria given in the UPDATE or DELETE
   statement in Python, to locate matching objects within the
   :class:`_orm.Session`.   This approach does not add any round trips and in
-  the absense of RETURNING support is more efficient.  For UPDATE or DELETE
+  the absence of RETURNING support is more efficient.  For UPDATE or DELETE
   statements with complex criteria, the ``'evaluate'`` strategy may not be
   able to evaluate the expression in Python and will raise an error.  If
   this occurs, use the ``'fetch'`` strategy for the operation instead.
@@ -817,7 +817,7 @@ automatically (it's currently not possible for a flush to continue after a
 partial failure). However, the :class:`_orm.Session` goes into a state known as
 "inactive" at this point, and the calling application must always call the
 :meth:`_orm.Session.rollback` method explicitly so that the
-:class:`_orm.Session` can go back into a useable state (it can also be simply
+:class:`_orm.Session` can go back into a usable state (it can also be simply
 closed and discarded). See the FAQ entry at :ref:`faq_session_rollback` for
 further discussion.
 
index bc901762b6db6f517bf45e6db9a04c5f58b66a23..e7401f618f9fca419bbff5b32e9b3364dc5f59c4 100644 (file)
@@ -14,7 +14,7 @@ Managing Transactions
 
 The :class:`_orm.Session` tracks the state of a single "virtual" transaction
 at a time, using an object called
-:class:`_orm.SessionTransaction`.   This object then makes use of the underyling
+:class:`_orm.SessionTransaction`.   This object then makes use of the underlying
 :class:`_engine.Engine` or engines to which the :class:`_orm.Session`
 object is bound in order to start real connection-level transactions using
 the :class:`_engine.Connection` object as needed.
@@ -59,7 +59,7 @@ or rolled back::
     session.commit()  # commits
 
     # will automatically begin again
-    result = session.execute(< some select statment >)
+    result = session.execute(< some select statement >)
     session.add_all([more_objects, ...])
     session.commit()  # commits
 
@@ -146,7 +146,7 @@ method::
     # commits u1 and u2
 
 Each time :meth:`_orm.Session.begin_nested` is called, a new "BEGIN SAVEPOINT"
-command is emitted to the database wih a unique identifier.  When
+command is emitted to the database with a unique identifier.  When
 :meth:`_orm.SessionTransaction.commit` is called, "RELEASE SAVEPOINT"
 is emitted on the database, and if instead
 :meth:`_orm.SessionTransaction.rollback` is called, "ROLLBACK TO SAVEPOINT"