Skip to content

Commit c5c89f4

Browse files
committed
Clarify the sense of 'rank' for documents.
Addresses: https://github.com/GoogleCloudPlatform/gcloud-python/pull/1173/files#r41574680
1 parent 06b828c commit c5c89f4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

gcloud/search/document.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,10 @@ class Document(object):
148148
:param index: the index to which the document belongs.
149149
150150
:type rank: positive integer
151-
:param rank: the default rank for ordering the document in queries: if
152-
not passed, assigned a timestamp-based value by the server.
153-
See the ``rank`` entry on the page above for details.
151+
:param rank: override the server-generated rank for ordering the document
152+
within in queries. If not passed, the server generates a
153+
timestamp-based value. See the ``rank`` entry on the
154+
page above for details.
154155
"""
155156
def __init__(self, name, index, rank=None):
156157
self.name = name

0 commit comments

Comments
 (0)