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 74e210164b87c4f151ed4cffff8344453db5b3f9..a8bb0f84afb983a034db41fe6a27f0ba4615e5b8 100644 (file)
--- 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 b395e6796416b5ff2d25405436d1d60e3277366c..d095857b9aaa7f9c37ef3f70c6c484dd8f8e653f 100644 (file)
--- 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: