Closed tseaver closed 5 years ago
Note that those same docstrings lie about the return type of their methods:
Returns:
A :class:`~google.gax.PageIterator` instance.
They are returning instances of google.api_core.page_iterator.GRPCIterator
.
From https://github.com/googleapis/google-cloud-python/issues/5560.
Examples in generated docstrings for methods returning iterators use
CallOptions
without importing it, e.g.:Worse, that usage is unidiomatic: the iterators returned from GAPIC methods have a
pages
attribute, which allows users to iterate pages without managing the token at all. E.g., for the example above, the more correct / idiomatic usage would be: