cqle: add Float/Double overload deprecation to upgrade guide

datastax · May 29, 2015 · f247df7 · f247df7
1 parent 101a4ab
commit f247df7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/api/cassandra/cqlengine/columns.rst b/docs/api/cassandra/cqlengine/columns.rst
@@ -58,7 +58,7 @@ Columns of all types are initialized by passing :class:`.Column` attributes to t
 
 .. autoclass:: Decimal(**kwargs)
 
-.. autoclass:: Double
+.. autoclass:: Double(**kwargs)
 
 .. autoclass:: Float
 

diff --git a/docs/cqlengine/upgrade_guide.rst b/docs/cqlengine/upgrade_guide.rst
@@ -79,6 +79,12 @@ This upgrade served as a good juncture to deprecate certain API features and inv
 to new ones. The first released version does not change functionality -- only introduces deprecation
 warnings. Future releases will remove these features in favor of the alternatives.
 
+Float/Double Overload
+---------------------
+Previously there was no ``Double`` column type. Doubles were modeled by specifying ``Float(double_precision=True)``.
+This inititializer parameter is now deprecated. Applications should use :class:`~.columns.Double` for CQL ``double``, and :class:`~.columns.Float`
+for CQL ``float``.
+
 Schema Management
 -----------------
 ``cassandra.cqlengine.management.create_keyspace`` is deprecated. Instead, use the new replication-strategy-specific