From: Mike Bayer Date: Thu, 9 Jan 2025 22:36:03 +0000 (-0500) Subject: fix changelog typos X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=84bf309e0223ea06c873a2ddb6f52fa6f5e1169c;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git fix changelog typos Change-Id: Ib1631c23fe8ad2d4aa4a537526faf970229af56d --- diff --git a/doc/build/changelog/unreleased_20/10720.rst b/doc/build/changelog/unreleased_20/10720.rst index d676a4425d..98ba0a0dc4 100644 --- a/doc/build/changelog/unreleased_20/10720.rst +++ b/doc/build/changelog/unreleased_20/10720.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/11370.rst b/doc/build/changelog/unreleased_20/11370.rst index 56e85531fc..a98940f8b6 100644 --- a/doc/build/changelog/unreleased_20/11370.rst +++ b/doc/build/changelog/unreleased_20/11370.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/11724.rst b/doc/build/changelog/unreleased_20/11724.rst index 3e8c436ebb..70ebd9e3e2 100644 --- a/doc/build/changelog/unreleased_20/11724.rst +++ b/doc/build/changelog/unreleased_20/11724.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/11764.rst b/doc/build/changelog/unreleased_20/11764.rst index 499852b6d0..6e37f86bf1 100644 --- a/doc/build/changelog/unreleased_20/11764.rst +++ b/doc/build/changelog/unreleased_20/11764.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/11944.rst b/doc/build/changelog/unreleased_20/11944.rst index e7469180ec..0be3cb926d 100644 --- a/doc/build/changelog/unreleased_20/11944.rst +++ b/doc/build/changelog/unreleased_20/11944.rst @@ -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]``. diff --git a/doc/build/changelog/unreleased_20/11955.rst b/doc/build/changelog/unreleased_20/11955.rst index eeeb2bcbdd..bf62530f99 100644 --- a/doc/build/changelog/unreleased_20/11955.rst +++ b/doc/build/changelog/unreleased_20/11955.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/12016.rst b/doc/build/changelog/unreleased_20/12016.rst index 5fa68d0372..e89c25576d 100644 --- a/doc/build/changelog/unreleased_20/12016.rst +++ b/doc/build/changelog/unreleased_20/12016.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/12093.rst b/doc/build/changelog/unreleased_20/12093.rst index b9ec3b1f88..3c6958d9ad 100644 --- a/doc/build/changelog/unreleased_20/12093.rst +++ b/doc/build/changelog/unreleased_20/12093.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/12100.rst b/doc/build/changelog/unreleased_20/12100.rst index 5fc111ae49..a7526dfd0c 100644 --- a/doc/build/changelog/unreleased_20/12100.rst +++ b/doc/build/changelog/unreleased_20/12100.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/12207.rst b/doc/build/changelog/unreleased_20/12207.rst index a6457b90ba..a69f8ae93a 100644 --- a/doc/build/changelog/unreleased_20/12207.rst +++ b/doc/build/changelog/unreleased_20/12207.rst @@ -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. diff --git a/doc/build/changelog/unreleased_20/7398.rst b/doc/build/changelog/unreleased_20/7398.rst index 9a27ae99a7..1241d175a3 100644 --- a/doc/build/changelog/unreleased_20/7398.rst +++ b/doc/build/changelog/unreleased_20/7398.rst @@ -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. diff --git a/doc/build/core/dml.rst b/doc/build/core/dml.rst index 7070277f14..1724dd6985 100644 --- a/doc/build/core/dml.rst +++ b/doc/build/core/dml.rst @@ -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