Skip to content

Commit 5ab96e8

Browse files
committed
Document that / lists passed as arguments must be empty.
1 parent 2db4b5d commit 5ab96e8

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

gcloud/datastore/connection.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -201,13 +201,13 @@ def lookup(self, dataset_id, key_pbs, missing=None, deferred=None):
201201
(or a single Key)
202202
:param key_pbs: The key (or keys) to retrieve from the datastore.
203203
204-
:type missing: list or None.
205-
:param missing: If a list is passed, the key-only entities returned
206-
by the backend as "missing" will be copied into it.
207-
Use only as a keyword param.
204+
:type missing: an empty list or None.
205+
:param missing: If a list is passed, the key-only entity protobufs
206+
returned by the backend as "missing" will be copied
207+
into it. Use only as a keyword param.
208208
209-
:type deferred: list or None.
210-
:param deferred: If a list is passed, the keys returned
209+
:type deferred: an empty list or None.
210+
:param deferred: If a list is passed, the key protobufs returned
211211
by the backend as "deferred" will be copied into it.
212212
Use only as a keyword param.
213213

gcloud/datastore/dataset.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,12 @@ def get_entities(self, keys, missing=None, deferred=None):
148148
:type key: list of :class:`gcloud.datastore.key.Key`
149149
:param item_name: The name of the item to retrieve.
150150
151-
:type missing: list or None.
151+
:type missing: an empty list or None.
152152
:param missing: If a list is passed, the key-only entities returned
153153
by the backend as "missing" will be copied into it.
154154
Use only as a keyword param.
155155
156-
:type deferred: list or None.
156+
:type deferred: an empty list or None.
157157
:param deferred: If a list is passed, the keys returned
158158
by the backend as "deferred" will be copied into it.
159159
Use only as a keyword param.

0 commit comments

Comments
 (0)