From 559d53c951554784587f3874f0e7832901689461 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Tue, 21 Jul 2015 11:09:41 -0700 Subject: [PATCH] Documenting Iterator constructor in datastore. See #978 for context. --- gcloud/datastore/query.py | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/gcloud/datastore/query.py b/gcloud/datastore/query.py index 1ae2c43dfa24..53cbfb2d0742 100644 --- a/gcloud/datastore/query.py +++ b/gcloud/datastore/query.py @@ -333,7 +333,31 @@ def fetch(self, limit=None, offset=0, start_cursor=None, end_cursor=None, class Iterator(object): - """Represent the state of a given execution of a Query.""" + """Represent the state of a given execution of a Query. + + :type query: :class:`gcloud.datastore.query.Query` + :param query: Query object holding permanent configuration (i.e. + things that don't change on with each page in + a results set). + + :type client: :class:`gcloud.datastore.client.Client` + :param client: The client used to make a request. + + :type limit: integer + :param limit: (Optional) Limit the number of results returned. + + :type offset: integer + :param offset: (Optional) Defaults to 0. Offset used to begin + a query. + + :type start_cursor: bytes + :param start_cursor: (Optional) Cursor to begin paging through + query results. + + :type end_cursor: bytes + :param end_cursor: (Optional) Cursor to end paging through + query results. + """ _NOT_FINISHED = datastore_pb.QueryResultBatch.NOT_FINISHED