Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Commit 943ad11

Browse files
authored
Remove incorrect restriction from docs for bookmarks (#481)
1 parent e80a07e commit 943ad11

File tree

4 files changed

+6
-10
lines changed

4 files changed

+6
-10
lines changed

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# UNRELEASED
22
- [REMOVED] Removed Python 2 compatibility from the supported environments.
3+
- [FIXED] Fixed the documentation for `bookmarks`.
34

45
# 2.14.0 (2020-08-17)
56

src/cloudant/database.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,8 +1242,7 @@ def get_query_result(self, selector, fields=None, raw_result=False,
12421242
wrapped in a QueryResult or if the response JSON is returned.
12431243
Defaults to False.
12441244
:param str bookmark: A string that enables you to specify which page of
1245-
results you require. Only valid for queries using indexes of type
1246-
*text*.
1245+
results you require.
12471246
:param int limit: Maximum number of results returned. Only valid if
12481247
used with ``raw_result=True``.
12491248
:param int page_size: Sets the page size for result iteration. Default

src/cloudant/query.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ class Query(dict):
6969
:param CloudantDatabase database: A Cloudant database instance used by the
7070
Query.
7171
:param str bookmark: A string that enables you to specify which page of
72-
results you require. Only valid for queries using indexes of type
73-
*text*.
72+
results you require.
7473
:param list fields: A list of fields to be returned by the query.
7574
:param int limit: Maximum number of results returned.
7675
:param int r: Read quorum needed for the result. Each document is read from
@@ -141,8 +140,7 @@ def __call__(self, **kwargs):
141140
and set ``raw_result=True`` instead.
142141
143142
:param str bookmark: A string that enables you to specify which page of
144-
results you require. Only valid for queries using indexes of type
145-
*text*.
143+
results you require.
146144
:param list fields: A list of fields to be returned by the query.
147145
:param int limit: Maximum number of results returned.
148146
:param int r: Read quorum needed for the result. Each document is read
@@ -204,8 +202,7 @@ def custom_result(self, **options):
204202
data = rslt[100:200]
205203
206204
:param str bookmark: A string that enables you to specify which page of
207-
results you require. Only valid for queries using indexes of type
208-
*text*.
205+
results you require.
209206
:param list fields: A list of fields to be returned by the query.
210207
:param int page_size: Sets the page size for result iteration. Default
211208
is 100.

src/cloudant/result.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -488,8 +488,7 @@ class QueryResult(Result):
488488
:param query: A reference to the query callable that returns
489489
the JSON content result to be wrapped.
490490
:param str bookmark: A string that enables you to specify which page of
491-
results you require. Only valid for queries using indexes of type
492-
*text*.
491+
results you require.
493492
:param list fields: A list of fields to be returned by the query.
494493
:param int page_size: Sets the page size for result iteration. Default
495494
is 100.

0 commit comments

Comments
 (0)