]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
fix changelog typos
authorMike Bayer <mike_mp@zzzcomputing.com>
Thu, 9 Jan 2025 22:36:03 +0000 (17:36 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Thu, 9 Jan 2025 22:36:39 +0000 (17:36 -0500)
Change-Id: Ib1631c23fe8ad2d4aa4a537526faf970229af56d
(cherry picked from commit 84bf309e0223ea06c873a2ddb6f52fa6f5e1169c)

12 files changed:
doc/build/changelog/unreleased_20/10720.rst
doc/build/changelog/unreleased_20/11370.rst
doc/build/changelog/unreleased_20/11724.rst
doc/build/changelog/unreleased_20/11764.rst
doc/build/changelog/unreleased_20/11944.rst
doc/build/changelog/unreleased_20/11955.rst
doc/build/changelog/unreleased_20/12016.rst
doc/build/changelog/unreleased_20/12093.rst
doc/build/changelog/unreleased_20/12100.rst
doc/build/changelog/unreleased_20/12207.rst
doc/build/changelog/unreleased_20/7398.rst
doc/build/core/dml.rst

index d676a4425d8e88daf4eff312df7fdb266767a94e..98ba0a0dc493a99bf93b727d1d47adbdc39f7331 100644 (file)
@@ -1,5 +1,6 @@
 .. change::
     :tags: usecase, mariadb
-    :ticket: 10720
+    :tickets: 10720
 
-    Added sql types ``INET4`` and ``INET6`` in the MariaDB dialect.
+    Added sql types ``INET4`` and ``INET6`` in the MariaDB dialect.  Pull
+    request courtesy Adam Žurek.
index 56e85531fc98fa038232f7c11d14e3c978f463bc..a98940f8b6a26b329a80bac5c405a37a37eb1cca 100644 (file)
@@ -4,12 +4,13 @@
 
     Fixed issue regarding ``Union`` types that would be present in the
     :paramref:`_orm.registry.type_annotation_map` of a :class:`_orm.registry`
-    or declarative base class, where a ``Mapped[]`` element that included one
-    of the subtypes present in that ``Union`` would be matched to that entry,
-    potentially ignoring other entries that matched exactly.   The correct
-    behavior now takes place such that an entry should only match in
-    ``type_annotation_map`` exactly, as a ``Union`` type is a self-contained
-    type. For example, an attribute with ``Mapped[float]`` would previously
-    match to a ``type_annotation_map`` entry ``Union[float, Decimal]``; this
-    will no longer match and will now only match to an entry that states
-    ``float``. Pull request courtesy Frazer McLean.
+    or declarative base class, where a :class:`.Mapped` element that included
+    one of the subtypes present in that ``Union`` would be matched to that
+    entry, potentially ignoring other entries that matched exactly.   The
+    correct behavior now takes place such that an entry should only match in
+    :paramref:`_orm.registry.type_annotation_map` exactly, as a ``Union`` type
+    is a self-contained type. For example, an attribute with ``Mapped[float]``
+    would previously match to a :paramref:`_orm.registry.type_annotation_map`
+    entry ``Union[float, Decimal]``; this will no longer match and will now
+    only match to an entry that states ``float``. Pull request courtesy Frazer
+    McLean.
index 3e8c436ebbca4d4c8b635bba0e1ae2e681ac0fe1..70ebd9e3e2f370b17d235ab7bfd177ff91f1493a 100644 (file)
@@ -1,7 +1,7 @@
 .. change::
     :tags: bug, postgresql
-    :ticket: 11724
+    :tickets: 11724
 
-    Fixes issue in `get_multi_indexes` in postgresql dialect, where an error
-    would be thrown when attempting to use alembic with a vector index from
-    the pgvecto.rs extension.
+    Fixes issue in :meth:`.Dialect.get_multi_indexes` in the PostgreSQL
+    dialect, where an error would be thrown when attempting to use alembic with
+    a vector index from the pgvecto.rs extension.
index 499852b6d09df5caf7ac1bc847433fe90226ff83..6e37f86bf16371883786a12d471476d1e8b626f9 100644 (file)
@@ -4,8 +4,8 @@
 
     Added support for the ``LIMIT`` clause with ``DELETE`` for the MySQL and
     MariaDB dialects, to complement the already present option for
-    ``UPDATE``. The :meth:`.delete.with_dialect_options` method of the
-    `:func:`.delete` construct accepts parameters for ``mysql_limit`` and
+    ``UPDATE``. The :meth:`.Delete.with_dialect_options` method of the
+    :func:`.delete` construct accepts parameters for ``mysql_limit`` and
     ``mariadb_limit``, allowing users to specify a limit on the number of rows
     deleted. Pull request courtesy of Pablo Nicolás Estevez.
 
@@ -14,7 +14,7 @@
     :tags:  bug, mysql, mariadb
 
     Added logic to ensure that the ``mysql_limit`` and ``mariadb_limit``
-    parameters of :meth:`.update.with_dialect_options` and
-    :meth:`.delete.with_dialect_options` when compiled to string will only
+    parameters of :meth:`.Update.with_dialect_options` and
+    :meth:`.Delete.with_dialect_options` when compiled to string will only
     compile if the parameter is passed as an integer; a ``ValueError`` is
     raised otherwise.
index e7469180ec2e55ba43df125b4e6ce8268f523a51..0be3cb926d7a0a333354d8a3c278ceae3de84b9e 100644 (file)
@@ -2,5 +2,7 @@
     :tags: bug, orm
     :tickets: 11944
 
-    Fixed bug in how type unions were handled that made the behavior
-    of ``a | b`` different from ``Union[a, b]``.
+    Fixed bug in how type unions were handled within
+    :paramref:`_orm.registry.type_annotation_map` as well as
+    :class:`._orm.Mapped` that made the lookup behavior of ``a | b`` different
+    from that of ``Union[a, b]``.
index eeeb2bcbddbc72231adcf4b909e41a86d3fe7951..bf62530f99d084700efcb6096f1e68b68528edc6 100644 (file)
@@ -2,12 +2,11 @@
     :tags: bug, orm
     :tickets: 11955
 
-    Consistently handle ``TypeAliasType`` (defined in PEP 695) obtained with the
-    ``type X = int`` syntax introduced in python 3.12.
-    Now in all cases one such alias must be explicitly added to the type map for
-    it to be usable inside ``Mapped[]``.
-    This change also revises the approach added in :ticket:`11305`, now requiring
-    the ``TypeAliasType`` to be added to the type map.
-    Documentation on how unions and type alias types are handled by SQLAlchemy
-    has been added in the :ref:`orm_declarative_mapped_column_type_map` section
-    of the documentation.
+    Consistently handle ``TypeAliasType`` (defined in PEP 695) obtained with
+    the ``type X = int`` syntax introduced in python 3.12. Now in all cases one
+    such alias must be explicitly added to the type map for it to be usable
+    inside :class:`.Mapped`. This change also revises the approach added in
+    :ticket:`11305`, now requiring the ``TypeAliasType`` to be added to the
+    type map. Documentation on how unions and type alias types are handled by
+    SQLAlchemy has been added in the
+    :ref:`orm_declarative_mapped_column_type_map` section of the documentation.
index 5fa68d037232e49a47c8cb96d24d1fef3f8af321..e89c25576d619bbafa028e991b70774aa833b9bb 100644 (file)
@@ -1,7 +1,8 @@
 .. change::
     :tags: feature, oracle
-    :ticket: 12016
+    :tickets: 12016
 
-    Added new table option `oracle_tablespace` to specify the `TABLESPACE` option
-    when creating a table in Oracle. This allows users to define the tablespace in 
-    which the table should be created. Pull request courtesy of Miguel Grillo.
+    Added new table option ``oracle_tablespace`` to specify the ``TABLESPACE``
+    option when creating a table in Oracle. This allows users to define the
+    tablespace in which the table should be created. Pull request courtesy of
+    Miguel Grillo.
index b9ec3b1f88bd4aa5118b732241585dc6bb221f0f..3c6958d9adb4461bc01885ebc6225cbe784b7bce 100644 (file)
@@ -1,6 +1,7 @@
 .. change::
     :tags: usecase, postgresql
-    :ticket: 12093
+    :tickets: 12093
 
-    The :class:`_postgresql.Range` type now supports ``__contains__``.
-    Pull request courtesy of Frazer McLean.
+    The :class:`_postgresql.Range` type now supports
+    :meth:`_postgresql.Range.__contains__`. Pull request courtesy of Frazer
+    McLean.
index 5fc111ae495c1f67c1cf9a5a213edf1390b0d637..a7526dfd0c4caa248ddf5e2ba2ebb8b4d481f2ac 100644 (file)
@@ -2,5 +2,5 @@
     :tags: bug, oracle
     :tickets: 12100
 
-    Fixed compilation of ``TABLE`` function when used in a from clause
-    in Oracle Database dialect.
+    Fixed compilation of ``TABLE`` function when used in a ``FROM`` clause in
+    Oracle Database dialect.
index a6457b90ba7953fc9376e00493da14551338d2fb..a69f8ae93a94ca0c9b656726e55a78b3e493d576 100644 (file)
@@ -2,7 +2,8 @@
     :tags: bug, orm
     :tickets: 12207
 
-    Fixed issues in type handling within the ``type_annotation_map`` feature
-    which prevented the use of unions, using either pep-604 or ``Union``
-    syntaxes under future annotations mode, which contained multiple generic
-    types as elements from being correctly resolvable.
+    Fixed issues in type handling within the
+    :paramref:`_orm.registry.type_annotation_map` feature which prevented the
+    use of unions, using either pep-604 or ``Union`` syntaxes under future
+    annotations mode, which contained multiple generic types as elements from
+    being correctly resolvable.
index 9a27ae99a735e98189d7486070cce1ddbc96555e..1241d175a3aa4476d5558744b9589417fc76b1ba 100644 (file)
@@ -1,6 +1,6 @@
 .. change::
     :tags: usecase, sqlite
-    :ticket: 7398
+    :tickets: 7398
 
-    Added SQLite table option to enable ``STRICT`` tables.
-    Pull request courtesy of Guilherme Crocetti.
+    Added SQLite table option to enable ``STRICT`` tables. Pull request
+    courtesy of Guilherme Crocetti.
index 7070277f14f37890ca771d047e58f71ccb17ed3e..1724dd6985c613d87daf4a8d87c1fea9a283b0d8 100644 (file)
@@ -32,11 +32,15 @@ Class documentation for the constructors listed at
 
    .. automethod:: Delete.where
 
+   .. automethod:: Delete.with_dialect_options
+
    .. automethod:: Delete.returning
 
 .. autoclass:: Insert
    :members:
 
+   .. automethod:: Insert.with_dialect_options
+
    .. automethod:: Insert.values
 
    .. automethod:: Insert.returning
@@ -48,6 +52,8 @@ Class documentation for the constructors listed at
 
    .. automethod:: Update.where
 
+   .. automethod:: Update.with_dialect_options
+
    .. automethod:: Update.values
 
 .. autoclass:: sqlalchemy.sql.expression.UpdateBase