link to with_variant() narrative from API doc

Change-Id: I5d8e4d7cb7871bedebe0fe89758be441e64b94c6
(cherry picked from commit 7f86be997eea27bc994b25c4fb65d72b3d4567f9)

diff --git a/doc/build/core/type_basics.rst b/doc/build/core/type_basics.rst
index 62d941e6639f45268d229798435f5c07f29ad11f..ed4d928e6d09a1556bad834ce1e90f66ca7ace22 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 30fc4189bba184a40ace5e3e60d984f6d9cdee4e..8c786968e01535e3228c31364c8e6a7337b2d380 100644 (file)
--- a/lib/sqlalchemy/sql/type_api.py
+++ b/lib/sqlalchemy/sql/type_api.py
@@ -543,6 +543,11 @@ class TypeEngine(Traversible):
         :param dialect_name: base name of the dialect which uses
          this type. (i.e. ``'postgresql'``, ``'mysql'``, etc.)
 
+        .. seealso::
+
+            :ref:`types_with_variant` - illustrates the use of
+            :meth:`_types.TypeEngine.with_variant`.
+
         """
         return Variant(self, {dialect_name: to_instance(type_)})