From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Tue, 3 Jan 2023 14:48:06 +0000 (-0500)
Subject: link to with_variant() narrative from API doc
X-Git-Tag: rel_2_0_0rc2~19
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7f86be997eea27bc994b25c4fb65d72b3d4567f9;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

link to with_variant() narrative from API doc

Change-Id: I5d8e4d7cb7871bedebe0fe89758be441e64b94c6
---

diff --git a/doc/build/core/type_basics.rst b/doc/build/core/type_basics.rst
index 74e210164b..a8bb0f84af 100644
--- a/doc/build/core/type_basics.rst
+++ b/doc/build/core/type_basics.rst
@@ -127,6 +127,8 @@ API documentation for backend-specific types are in the dialect-specific
 documentation, listed at :ref:`dialect_toplevel`.
 
 
+.. _types_with_variant:
+
 Using "UPPERCASE" and Backend-specific types for multiple backends
 ------------------------------------------------------------------
 
diff --git a/lib/sqlalchemy/sql/type_api.py b/lib/sqlalchemy/sql/type_api.py
index b395e67964..d095857b9a 100644
--- a/lib/sqlalchemy/sql/type_api.py
+++ b/lib/sqlalchemy/sql/type_api.py
@@ -681,6 +681,11 @@ class TypeEngine(Visitable, Generic[_T]):
          .. versionchanged:: 2.0 multiple dialect names can be specified
             for one variant.
 
+        .. seealso::
+
+            :ref:`types_with_variant` - illustrates the use of
+            :meth:`_types.TypeEngine.with_variant`.
+
         """
 
         if not dialect_names: