- 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 fca0ddb03e9c5d55a7199e3b4afb5d74b7f5e407..e1ea26a9c4f8c61228356129d616f56dd8457f30 100644 (file)
--- a/doc/build/core/custom_types.rst
+++ b/doc/build/core/custom_types.rst
@@ -66,7 +66,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 9e052c6b434f00e47bb8a691a1dd1a48a0cdbd7a..5f96b1aad8a41ccdb78a4d4b481c8620e3b03303 100644 (file)
--- a/lib/sqlalchemy/sql/type_api.py
+++ b/lib/sqlalchemy/sql/type_api.py
@@ -903,6 +903,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):