From 33a90ea78c67c8cf055a034489a419777667c82b Mon Sep 17 00:00:00 2001 From: Kevin Kirsche Date: Sat, 11 Sep 2021 16:39:08 -0400 Subject: Fix/typos doc build (#910) * fix: typos in docs/build/batch.rst * fix: typos in docs/build/autogenerate.rst * fix: typos in docs/build/changelog.rst --- docs/build/autogenerate.rst | 2 +- docs/build/batch.rst | 2 +- docs/build/changelog.rst | 22 +++++++++++----------- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/build/autogenerate.rst b/docs/build/autogenerate.rst index ba2540c..a623372 100644 --- a/docs/build/autogenerate.rst +++ b/docs/build/autogenerate.rst @@ -471,7 +471,7 @@ either manually, or by adding it to ``script.py.mako``. The above custom type has a long and cumbersome name based on the use of ``__module__`` directly, which also implies that lots of imports would -be needed in order to accomodate lots of types. For this reason, it is +be needed in order to accommodate lots of types. For this reason, it is recommended that user-defined types used in migration scripts be made available from a single module. Suppose we call it ``myapp.migration_types``:: diff --git a/docs/build/batch.rst b/docs/build/batch.rst index 7b14a64..6c2e9d4 100644 --- a/docs/build/batch.rst +++ b/docs/build/batch.rst @@ -362,7 +362,7 @@ Autogenerate will now generate along the lines of:: This mode is safe to use in all cases, as the :meth:`.Operations.batch_alter_table` directive by default only takes place for SQLite; other backends will -behave just as they normally do in the absense of the batch directives. +behave just as they normally do in the absence of the batch directives. Note that autogenerate support does not include "offline" mode, where the :paramref:`.Operations.batch_alter_table.copy_from` parameter is used. diff --git a/docs/build/changelog.rst b/docs/build/changelog.rst index 99e52f2..5c30ce7 100644 --- a/docs/build/changelog.rst +++ b/docs/build/changelog.rst @@ -387,7 +387,7 @@ Changelog Add async template to Alembic to bootstrap environments that use async DBAPI. Updated the cookbook to include a migration guide - on how to adapt an existing enviroment for use with DBAPI drivers. + on how to adapt an existing environment for use with DBAPI drivers. .. changelog:: :version: 1.5.5 @@ -567,7 +567,7 @@ Changelog **before** the SQLAlchemy reflection process takes place, and notably includes explicit support for passing each schema name when :paramref:`.EnvironmentContext.configure.include_schemas` is set to True. - This is most important especially for enviroments that make use of + This is most important especially for environments that make use of :paramref:`.EnvironmentContext.configure.include_schemas` where schemas are actually databases (e.g. MySQL) in order to prevent reflection sweeps of the entire server. @@ -1061,7 +1061,7 @@ Changelog Added new feature :meth:`.MigrationContext.autocommit_block`, a special directive which will provide for a non-transactional block inside of a - migration script. The feature requres that: the database driver + migration script. The feature requires that: the database driver (e.g. DBAPI) supports the AUTOCOMMIT isolation mode. The directive also necessarily needs to COMMIT the existing transaction in progress in order to enter autocommit mode. @@ -1321,7 +1321,7 @@ Changelog :tags: bug, py3k :tickets: 563 - Replaced the Python compatbility routines for ``getargspec()`` with a fully + Replaced the Python compatibility routines for ``getargspec()`` with a fully vendored version based on ``getfullargspec()`` from Python 3.3. Originally, Python was emitting deprecation warnings for this function in Python 3.8 alphas. While this change was reverted, it was observed that @@ -1889,7 +1889,7 @@ Changelog Added a new configuration option ``timezone``, a string timezone name that will be applied to the create date timestamp rendered - inside the revision file as made availble to the ``file_template`` used + inside the revision file as made available to the ``file_template`` used to generate the revision filename. Note this change adds the ``python-dateutil`` package as a dependency. @@ -2021,7 +2021,7 @@ Changelog :tags: bug, operations Fixed bug in :func:`.ops.create_foreign_key` where the internal table - representation would not be created properly if the foriegn key referred + representation would not be created properly if the foreign key referred to a table in a different schema of the same name. Pull request courtesy Konstantin Lebedev. @@ -2247,7 +2247,7 @@ Changelog Added a fix to Postgresql server default comparison which first checks if the text of the default is identical to the original, before attempting - to actually run the default. This accomodates for default-generation + to actually run the default. This accommodates for default-generation functions that generate a new value each time such as a uuid function. .. change:: @@ -3801,7 +3801,7 @@ Changelog .. change:: :tags: bug - Fixes to Py3k in-place compatibity regarding output encoding and related; + Fixes to Py3k in-place compatibility regarding output encoding and related; the use of the new io.* package introduced some incompatibilities on Py2k. These should be resolved, due to the introduction of new adapter types for translating from io.* to Py2k file types, StringIO types. @@ -4082,7 +4082,7 @@ Changelog :tickets: 99 Fixed bug where autogenerate would fail if a Column - to be added to a table made use of the ".key" paramter. + to be added to a table made use of the ".key" parameter. .. change:: :tags: bug, sqlite @@ -4104,7 +4104,7 @@ Changelog :tickets: 96 Added a workaround to setup.py to prevent - "NoneType" error from occuring when + "NoneType" error from occurring when "setup.py test" is run. .. change:: @@ -4316,7 +4316,7 @@ Changelog :tags: bug :tickets: 66 - Improved error message when specifiying + Improved error message when specifying non-ordered revision identifiers to cover the case when the "higher" rev is None, improved message overall. -- cgit v1.2.1