Clarify behavior when allow_rate_limited_scan_without_consumed_capacity is False. (pynamodb#399)

scode · jpinner-lyft · commit 37a7dfaa4935 · 2017-10-29T11:41:46.000-07:00
diff --git a/docs/settings.rst b/docs/settings.rst
@@ -61,7 +61,9 @@ Default: ``False``
 
 If ``True``, ``rate_limited_scan()`` will proceed silently (without
 rate limiting) if the DynamoDB server does not return consumed
-capacity information in responses.
+capacity information in responses. If ``False``, scans will fail
+should the server not return consumed capacity information in an
+effort to prevent unintentional capacity usage..
 
 Overriding settings
 ~~~~~~~~~~~~~~~~~~~
