Merge pull request apache#908 from datastax/python-901

aboudreault · web-flow · commit 13b7010b8f4e · 2018-01-22T18:42:43.000-05:00
PYTHON-901: minor improvement in ExecutionProfile and Metrics docs
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -24,6 +24,7 @@ Other
 * Remove "Experimental" tag from execution profiles documentation (PYTHON-840)
 * request_timer metrics descriptions are slightly incorrect (PYTHON-885)
 * Remove "Experimental" tag from cqlengine connections documentation (PYTHON-892)
+* Set in documentation default consistency for operations is LOCAL_ONE (PYTHON-901)
 
 3.12.0
 ======
diff --git a/cassandra/metrics.py b/cassandra/metrics.py
@@ -28,6 +28,8 @@
 class Metrics(object):
     """
     A collection of timers and counters for various performance metrics.
+
+    Timer metrics are represented as floating point seconds.
     """
 
     request_timer = None
diff --git a/docs/api/cassandra/cluster.rst b/docs/api/cassandra/cluster.rst
@@ -114,8 +114,12 @@
 
    .. automethod:: set_meta_refresh_enabled
 
-.. autoclass:: ExecutionProfile
+.. autoclass:: ExecutionProfile (load_balancing_policy=<object object>, retry_policy=None, consistency_level=LOCAL_ONE, serial_consistency_level=None, request_timeout=10.0, row_factory=<function tuple_factory>, speculative_execution_policy=None)
    :members:
+   :exclude-members: consistency_level
+
+   .. autoattribute:: consistency_level
+      :annotation: = LOCAL_ONE
 
 .. autodata:: EXEC_PROFILE_DEFAULT
    :annotation:
