Make note of num_results property on iterators

Ben Demaree · Ben Demaree · commit 79d342a16464 · 2017-01-18T09:42:44.000-06:00
diff --git a/core/google/cloud/iterator.py b/core/google/cloud/iterator.py
@@ -42,6 +42,14 @@
     ...     if not my_item.is_valid:
     ...         break
 
+At any point, you may check the number of items consumed by referencing the
+``num_results`` property of the iterator::
+
+    >>> my_iterator = Iterator(...)
+    ... for my_item in my_iterator:
+    ...     if my_iterator.num_results >= 10:
+    ...         break
+
 When iterating, not every new item will send a request to the server.
 To iterate based on each page of items (where a page corresponds to
 a request)::
