summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2019-08-10 22:20:31 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2019-08-10 22:21:26 -0400
commita21d7afc558307d01b3e98f20ace123b33b1ec86 (patch)
tree65cba939bc3e07ccc694d50945f6862eb07b4567
parent769f568c54a1cfae66735128c442758602ca755e (diff)
downloadsqlalchemy-a21d7afc558307d01b3e98f20ace123b33b1ec86.tar.gz
- shore up TypeDecorator docs a bit to not render tons of
comparator methods Change-Id: I8f434b18b2bd632a0db0db1376262944272d2198 (cherry picked from commit 731a20049b372ee2e0c7408519623363e22a4db4)
-rw-r--r--doc/build/core/custom_types.rst1
-rw-r--r--lib/sqlalchemy/sql/type_api.py9
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/build/core/custom_types.rst b/doc/build/core/custom_types.rst
index 01902420a..c3a88509c 100644
--- 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 5404c8de6..d2a1c6158 100644
--- 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):