Remove old version notes, prior to version 1.7

This also removes some old docs regarding sqlalchemy version prior to version 1 Change-Id: If983df98c07d4a0a6492c151b407b735b74780dc
zzzeek · Aug 12, 2023 · 2eb96e3 · 2eb96e3
1 parent 381f58b
commit 2eb96e3
Show file tree

Hide file tree

Showing 14 changed files with 5 additions and 145 deletions.
diff --git a/alembic/command.py b/alembic/command.py
@@ -54,9 +54,6 @@ def init(
     :param package: when True, write ``__init__.py`` files into the
      environment location as well as the versions/ location.
 
-     .. versionadded:: 1.2
-
-
     """
 
     if os.access(directory, os.F_OK) and os.listdir(directory):
@@ -625,9 +622,6 @@ def stamp(
      .. note:: this parameter is called "revisions" in the command line
         interface.
 
-     .. versionchanged:: 1.2  The revision may be a single revision or
-        list of revisions when stamping multiple branch heads.
-
     :param sql: use ``--sql`` mode
 
     :param tag: an arbitrary "tag" that can be intercepted by custom
@@ -636,8 +630,6 @@ def stamp(
 
     :param purge: delete all entries in the version table before stamping.
 
-     .. versionadded:: 1.2
-
     """
 
     script = ScriptDirectory.from_config(config)

diff --git a/alembic/context.pyi b/alembic/context.pyi
@@ -226,9 +226,6 @@ def configure(
      ``connection`` and ``url`` are not passed.
     :param dialect_opts: dictionary of options to be passed to dialect
      constructor.
-
-     .. versionadded:: 1.0.12
-
     :param transactional_ddl: Force the usage of "transactional"
      DDL on or off;
      this otherwise defaults to whether or not the dialect in
@@ -400,8 +397,6 @@ def configure(
             include_name = include_name
         )
 
-     .. versionadded:: 1.5
-
      .. seealso::
 
         :ref:`autogenerate_include_hooks`

diff --git a/alembic/ddl/impl.py b/alembic/ddl/impl.py
@@ -571,8 +571,6 @@ def render_ddl_sql_expr(
         """Render a SQL expression that is typically a server default,
         index expression, etc.
 
-        .. versionadded:: 1.0.11
-
         """
 
         compile_kw = {

diff --git a/alembic/op.pyi b/alembic/op.pyi
@@ -181,9 +181,6 @@ def alter_column(
      Set to ``None`` to have the default removed.
     :param comment: optional string text of a new comment to add to the
      column.
-
-     .. versionadded:: 1.0.6
-
     :param new_column_name: Optional; specify a string name here to
      indicate the new name within a column rename operation.
     :param type\_: Optional; a :class:`~sqlalchemy.types.TypeEngine`
@@ -217,9 +214,6 @@ def alter_column(
     :param existing_comment: string text of the existing comment on the
      column to be maintained.  Required on MySQL if the existing comment
      on the column is not being changed.
-
-     .. versionadded:: 1.0.6
-
     :param schema: Optional schema name to operate within.  To control
      quoting of the schema outside of the default behavior, use
      the SQLAlchemy construct
@@ -374,8 +368,6 @@ def batch_alter_table(
      set is undefined.   Therefore it is best to specify the complete
      ordering of all columns for best results.
 
-     .. versionadded:: 1.4.0
-
     .. note:: batch mode requires SQLAlchemy 0.8 or above.
 
     .. seealso::
@@ -827,8 +819,6 @@ def create_table_comment(
 ) -> None:
     """Emit a COMMENT ON operation to set the comment for a table.
 
-    .. versionadded:: 1.0.6
-
     :param table_name: string name of the target table.
     :param comment: string value of the comment being registered against
      the specified table.
@@ -1021,8 +1011,6 @@ def drop_table_comment(
     """Issue a "drop table comment" operation to
     remove an existing comment set on a table.
 
-    .. versionadded:: 1.0.6
-
     :param table_name: string name of the target table.
     :param existing_comment: An optional string value of a comment already
      registered on the specified table.

diff --git a/alembic/operations/base.py b/alembic/operations/base.py
@@ -350,8 +350,6 @@ def batch_alter_table(
          set is undefined.   Therefore it is best to specify the complete
          ordering of all columns for best results.
 
-         .. versionadded:: 1.4.0
-
         .. note:: batch mode requires SQLAlchemy 0.8 or above.
 
         .. seealso::
@@ -709,9 +707,6 @@ def alter_column(
              Set to ``None`` to have the default removed.
             :param comment: optional string text of a new comment to add to the
              column.
-
-             .. versionadded:: 1.0.6
-
             :param new_column_name: Optional; specify a string name here to
              indicate the new name within a column rename operation.
             :param type\_: Optional; a :class:`~sqlalchemy.types.TypeEngine`
@@ -745,9 +740,6 @@ def alter_column(
             :param existing_comment: string text of the existing comment on the
              column to be maintained.  Required on MySQL if the existing comment
              on the column is not being changed.
-
-             .. versionadded:: 1.0.6
-
             :param schema: Optional schema name to operate within.  To control
              quoting of the schema outside of the default behavior, use
              the SQLAlchemy construct
@@ -1223,8 +1215,6 @@ def create_table_comment(
         ) -> None:
             """Emit a COMMENT ON operation to set the comment for a table.
 
-            .. versionadded:: 1.0.6
-
             :param table_name: string name of the target table.
             :param comment: string value of the comment being registered against
              the specified table.
@@ -1428,8 +1418,6 @@ def drop_table_comment(
             """Issue a "drop table comment" operation to
             remove an existing comment set on a table.
 
-            .. versionadded:: 1.0.6
-
             :param table_name: string name of the target table.
             :param existing_comment: An optional string value of a comment already
              registered on the specified table.
@@ -1629,17 +1617,13 @@ def alter_column(
             :param insert_before: String name of an existing column which this
              column should be placed before, when creating the new table.
 
-             .. versionadded:: 1.4.0
-
             :param insert_after: String name of an existing column which this
              column should be placed after, when creating the new table.  If
              both :paramref:`.BatchOperations.alter_column.insert_before`
              and :paramref:`.BatchOperations.alter_column.insert_after` are
              omitted, the column is inserted after the last existing column
              in the table.
 
-             .. versionadded:: 1.4.0
-
             .. seealso::
 
                 :meth:`.Operations.alter_column`
@@ -1759,8 +1743,6 @@ def create_table_comment(
             """Emit a COMMENT ON operation to set the comment for a table
             using the current batch migration context.
 
-            .. versionadded:: 1.6.0
-
             :param comment: string value of the comment being registered against
              the specified table.
             :param existing_comment: String value of a comment
@@ -1832,8 +1814,6 @@ def drop_table_comment(
             remove an existing comment set on a table using the current
             batch operations context.
 
-            .. versionadded:: 1.6.0
-
             :param existing_comment: An optional string value of a comment already
              registered on the specified table.
 

diff --git a/alembic/operations/ops.py b/alembic/operations/ops.py
@@ -1482,8 +1482,6 @@ def create_table_comment(
     ) -> None:
         """Emit a COMMENT ON operation to set the comment for a table.
 
-        .. versionadded:: 1.0.6
-
         :param table_name: string name of the target table.
         :param comment: string value of the comment being registered against
          the specified table.
@@ -1519,8 +1517,6 @@ def batch_create_table_comment(
         """Emit a COMMENT ON operation to set the comment for a table
         using the current batch migration context.
 
-        .. versionadded:: 1.6.0
-
         :param comment: string value of the comment being registered against
          the specified table.
         :param existing_comment: String value of a comment
@@ -1595,8 +1591,6 @@ def drop_table_comment(
         """Issue a "drop table comment" operation to
         remove an existing comment set on a table.
 
-        .. versionadded:: 1.0.6
-
         :param table_name: string name of the target table.
         :param existing_comment: An optional string value of a comment already
          registered on the specified table.
@@ -1623,8 +1617,6 @@ def batch_drop_table_comment(
         remove an existing comment set on a table using the current
         batch operations context.
 
-        .. versionadded:: 1.6.0
-
         :param existing_comment: An optional string value of a comment already
          registered on the specified table.
 
@@ -1873,9 +1865,6 @@ def alter_column(
          Set to ``None`` to have the default removed.
         :param comment: optional string text of a new comment to add to the
          column.
-
-         .. versionadded:: 1.0.6
-
         :param new_column_name: Optional; specify a string name here to
          indicate the new name within a column rename operation.
         :param type\_: Optional; a :class:`~sqlalchemy.types.TypeEngine`
@@ -1909,9 +1898,6 @@ def alter_column(
         :param existing_comment: string text of the existing comment on the
          column to be maintained.  Required on MySQL if the existing comment
          on the column is not being changed.
-
-         .. versionadded:: 1.0.6
-
         :param schema: Optional schema name to operate within.  To control
          quoting of the schema outside of the default behavior, use
          the SQLAlchemy construct
@@ -1972,17 +1958,13 @@ def batch_alter_column(
         :param insert_before: String name of an existing column which this
          column should be placed before, when creating the new table.
 
-         .. versionadded:: 1.4.0
-
         :param insert_after: String name of an existing column which this
          column should be placed after, when creating the new table.  If
          both :paramref:`.BatchOperations.alter_column.insert_before`
          and :paramref:`.BatchOperations.alter_column.insert_after` are
          omitted, the column is inserted after the last existing column
          in the table.
 
-         .. versionadded:: 1.4.0
-
         .. seealso::
 
             :meth:`.Operations.alter_column`

diff --git a/alembic/runtime/environment.py b/alembic/runtime/environment.py
@@ -466,9 +466,6 @@ def configure(
          ``connection`` and ``url`` are not passed.
         :param dialect_opts: dictionary of options to be passed to dialect
          constructor.
-
-         .. versionadded:: 1.0.12
-
         :param transactional_ddl: Force the usage of "transactional"
          DDL on or off;
          this otherwise defaults to whether or not the dialect in
@@ -640,8 +637,6 @@ def include_name(name, type_, parent_names):
                 include_name = include_name
             )
 
-         .. versionadded:: 1.5
-
          .. seealso::
 
             :ref:`autogenerate_include_hooks`

diff --git a/alembic/runtime/migration.py b/alembic/runtime/migration.py
@@ -320,8 +320,6 @@ def upgrade():
             migrations whether or not one of them has an autocommit block.
 
 
-        .. versionadded:: 1.2.0
-
         """
         _in_connection_transaction = self._in_connection_transaction()
 

diff --git a/alembic/script/write_hooks.py b/alembic/script/write_hooks.py
@@ -25,8 +25,6 @@ def register(name: str) -> Callable:
 
     See the documentation linked below for an example.
 
-    .. versionadded:: 1.2.0
-
     .. seealso::
 
         :ref:`post_write_hooks_custom`

diff --git a/docs/build/autogenerate.rst b/docs/build/autogenerate.rst
@@ -142,14 +142,6 @@ Autogenerate can **optionally detect**:
   The type comparison logic is fully extensible as well; see
   :ref:`compare_types` for details.
 
-  .. versionchanged:: 1.4 type comparison code has been reworked such that
-     column types are compared based on their rendered DDL, which should allow
-     the functionality enabled by
-     :paramref:`.EnvironmentContext.configure.compare_type`
-     to be much more accurate, correctly accounting for the behavior of
-     SQLAlchemy "generic" types as well as major arguments specified within
-     types.
-
 * Change of server default.  This will occur if you set
   the :paramref:`.EnvironmentContext.configure.compare_server_default`
   parameter to ``True``, or to a custom callable function.
@@ -393,9 +385,6 @@ rules that include both :class:`~sqlalchemy.schema.MetaData` and reflected
 object, the :paramref:`.EnvironmentContext.configure.include_object` hook
 discussed in the next section is more appropriate.
 
-.. versionadded:: 1.5 added the :paramref:`.EnvironmentContext.configure.include_name`
-    hook.
-
 Omitting Based on Object
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -629,8 +618,6 @@ is set to True::
      database backend sets as a default value without generating false
      positives.
 
-.. versionchanged:: 1.4.0 Added the text and keyword comparison for column types
-
 Alternatively, the :paramref:`.EnvironmentContext.configure.compare_type`
 parameter accepts a callable function which may be used to implement custom type
 comparison logic, for cases such as where special user defined types
@@ -698,10 +685,6 @@ first; if it returns ``None``, then the ``compare_against_backend`` method
 will be used, if present on the metadata type.  If that returns ``None``,
 then a basic check for type equivalence is run.
 
-.. versionadded:: 1.4.0 - added column keyword comparisons and the
-   ``type_synonyms`` property.
-
-
 .. _post_write_hooks:
 
 Applying Post Processing and Python Code Formatters to Generated Revisions
@@ -720,8 +703,6 @@ path to the newly generated file as well as configuration options.
 The post write hooks, when configured,  run against generated revision files
 regardless of whether or not the autogenerate feature was used.
 
-.. versionadded:: 1.2
-
 .. note::
 
     Alembic's post write system is partially inspired by the `pre-commit