]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
various minor docs improvements
authorFederico Caselli <cfederico87@gmail.com>
Mon, 12 Jun 2023 20:08:19 +0000 (22:08 +0200)
committerFederico Caselli <cfederico87@gmail.com>
Mon, 12 Jun 2023 20:28:25 +0000 (22:28 +0200)
Change-Id: I5e7332047c03260792bf990aafd0ef4e15f5f082

doc/build/changelog/whatsnew_20.rst
doc/build/orm/dataclasses.rst
doc/build/tutorial/further_reading.rst
lib/sqlalchemy/dialects/postgresql/ext.py

index 1a0f29c4a90c28c8ba892b000f707c5bcac5b5e1..179ed55f2dace0626f7c2bbaabc59b99b5827d8d 100644 (file)
@@ -684,8 +684,8 @@ or ``Mapped[user_fk]`` draw from both the
 ``Annotated`` construct directly in order to re-use pre-established typing
 and column configurations.
 
-Step six - turn mapped classes into dataclasses_
-+++++++++++++++++++++++++++++++++++++++++++++++++
+Optional step - turn mapped classes into dataclasses_
++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 We can turn mapped classes into dataclasses_, where a key advantage
 is that we can build a strictly-typed ``__init__()`` method with explicit
index 1421b0ad2bc871f1176791ddecd5ff4e6bad57f7..639140b2fb79c13ca4717334aeb140c002ecaeb2 100644 (file)
@@ -528,9 +528,10 @@ variable may be generated::
 Integrating with Alternate Dataclass Providers such as Pydantic
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. warning::  Pydantic's dataclass layer is **not fully compatible with
-   SQLAlchemy's class instrumentation without additional internal changes, and
-   many features such as related collections may not work correctly.**.
+.. warning::  The dataclass layer of Pydantic version 1.x is **not fully
+    compatible with SQLAlchemy's class instrumentation without additional
+    internal changes, and many features such as related collections may
+    not work correctly.**.
 
    For Pydantic compatibility, please consider the
    `SQLModel <https://sqlmodel.tiangolo.com/>` ORM which is built with
index d8b792f03d572abc35afd524ef91ff33e2fdba15..2335f5f923e7167692a2839b85b0b847dd6da3af 100644 (file)
@@ -36,9 +36,4 @@ ORM Essential Reference
 
 * :ref:`session_toplevel`
 
-* :doc:`/orm/loading_objects`
-
-
-
-
-
+* :doc:`queryguide/index`
index 151bd809d0bc34aab35577eb671829157693fab3..ad1267750bb61d7aa28ea742b55e85e04ef89e92 100644 (file)
@@ -158,6 +158,10 @@ class ExcludeConstraint(ColumnCollectionConstraint):
                 )
             )
 
+        The exclude constraint defined in this example requires the
+        ``btree_gist`` extension, that can be created using the
+        command ``CREATE EXTENSION btree_gist;``.
+
         :param \*elements:
 
           A sequence of two tuples of the form ``(column, operator)`` where