Skip to content

Commit

Permalink
Fixed minor omission in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
pekrau committed May 6, 2021
1 parent 996b510 commit 677539a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ db.destroy()
- Fixed setup.py.
- Added `__del__` to Server class.
- Simplified `get_scheduler_docs`.
- Hide module-level functions which are just help functions for the
- Hid module-level functions which are just help functions for the
command-line tool.
- Removed `CouchDB version >= 2.0` from some methods incorrectly
marked as such.
Expand Down Expand Up @@ -505,9 +505,10 @@ Deletes the named index in the design document of the given name.
data = db.find(selector, limit=25, skip=None, sort=None, fields=None,
use_index=None, bookmark=None, update=True, conflicts=False)
```
Selects documents according to the Mango index `selector`. For more information
on selector syntax, see https://docs.couchdb.org/en/latest/api/database/find.html#find-selectors
Selects documents according to the Mango index `selector`.

- `selector`: The Mango index. For more information on selector syntax,
see https://docs.couchdb.org/en/latest/api/database/find.html#find-selectors
- `limit`: Maximum number of results returned.
- `skip`: Skip the given number of results.
- `sort`: A list of dictionaries specifying the order of the results,
Expand All @@ -533,6 +534,8 @@ data = db.explain(selector, use_index=None, limit=None, skip=None,
```
Returns info on which index is being used by the query.

- `selector`: The Mango index. For more information on selector syntax,
see https://docs.couchdb.org/en/latest/api/database/find.html#find-selectors
- `limit`: Maximum number of results returned.
- `skip`: Skip the given number of results.
- `sort`: A list of dictionaries specifying the order of the results,
Expand Down
8 changes: 5 additions & 3 deletions couchdb2.py
Original file line number Diff line number Diff line change
Expand Up @@ -697,10 +697,10 @@ def delete_index(designname, name):

def find(self, selector, limit=None, skip=None, sort=None, fields=None,
use_index=None, bookmark=None, update=True, conflicts=False):
"""Select documents according to the Mango index `selector`.
For more information on selector syntax, see
https://docs.couchdb.org/en/latest/api/database/find.html#find-selectors
"""Selects documents according to the Mango index `selector`.
- `selector`: The Mango index. For more information on selector syntax,
see https://docs.couchdb.org/en/latest/api/database/find.html#find-selectors
- `limit`: Maximum number of results returned.
- `skip`: Skip the given number of results.
- `sort`: A list of dictionaries specifying the order of the results,
Expand Down Expand Up @@ -742,6 +742,8 @@ def explain(self, selector, limit=None, skip=None,
sort=None, fields=None, bookmark=None):
"""Return info on which index is being used by the query.
- `selector`: The Mango index. For more information on selector syntax,
see https://docs.couchdb.org/en/latest/api/database/find.html#find-selectors
- `limit`: Maximum number of results returned.
- `skip`: Skip the given number of results.
- `sort`: A list of dictionaries specifying the order of the results,
Expand Down

0 comments on commit 677539a

Please sign in to comment.