cqle doc: deprecated TimeUUID.from_datetime

aholmberg · aholmberg · commit f2403d0380ce · 2015-06-12T10:40:44.000-05:00
diff --git a/cassandra/cqlengine/columns.py b/cassandra/cqlengine/columns.py
@@ -557,7 +557,12 @@ def from_datetime(self, dt):
 
         :param dt: datetime
         :type dt: datetime
-        :return:
+        :return: uuid1
+
+        .. deprecated:: 2.6.0
+
+            Use :func:`cassandra.util.uuid_from_time`
+
         """
         msg = "cqlengine.columns.TimeUUID.from_datetime is deprecated. Use cassandra.util.uuid_from_time instead."
         warnings.warn(msg, DeprecationWarning)
diff --git a/docs/api/cassandra/cqlengine/columns.rst b/docs/api/cassandra/cqlengine/columns.rst
@@ -78,6 +78,8 @@ Columns of all types are initialized by passing :class:`.Column` attributes to t
 
 .. autoclass:: TimeUUID(**kwargs)
 
+    .. automethod:: from_datetime
+
 .. autoclass:: TinyInt(**kwargs)
 
 .. autoclass:: UserDefinedType
diff --git a/docs/cqlengine/upgrade_guide.rst b/docs/cqlengine/upgrade_guide.rst
@@ -150,3 +150,6 @@ After::
         __discriminator_value__ = 'dog'
 
 
+TimeUUID.from_datetime
+----------------------
+This function is deprecated in favor of the core utility function :func:`~.uuid_from_time`.
