- shore up TypeDecorator docs a bit to not render tons of

comparator methods

Change-Id: I8f434b18b2bd632a0db0db1376262944272d2198
(cherry picked from commit 731a20049b372ee2e0c7408519623363e22a4db4)

diff --git a/doc/build/core/custom_types.rst b/doc/build/core/custom_types.rst
index 01902420a75e0901572f6d28374a70906decfae7..c3a88509ccd87e2f497763d023cf87f2d6420d7d 100644 (file)
--- a/doc/build/core/custom_types.rst
+++ b/doc/build/core/custom_types.rst
@@ -65,7 +65,6 @@ to and/or from the database is required.
 
 .. autoclass:: TypeDecorator
    :members:
-   :inherited-members:
 
 
 TypeDecorator Recipes

diff --git a/lib/sqlalchemy/sql/type_api.py b/lib/sqlalchemy/sql/type_api.py
index 5404c8de6eb51ce39c724581284ce4fc5d6f68b1..d2a1c6158d134a8c581121ed91bf04880c019b17 100644 (file)
--- a/lib/sqlalchemy/sql/type_api.py
+++ b/lib/sqlalchemy/sql/type_api.py
@@ -793,6 +793,15 @@ class TypeDecorator(SchemaEventTarget, TypeEngine):
     """
 
     class Comparator(TypeEngine.Comparator):
+        """A :class:`.TypeEngine.Comparator` that is specific to
+        :class:`.TypeDecorator`.
+
+        User-defined :class:`.TypeDecorator` classes should not typically
+        need to modify this.
+
+
+        """
+
         __slots__ = ()
 
         def operate(self, op, *other, **kwargs):