summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIsis Lovecruft <isis@torproject.org>2013-04-15 19:55:19 +0000
committerIsis Lovecruft <isis@torproject.org>2013-04-15 19:55:19 +0000
commit471c584b4fac9de68200f3b252292f1735f3d1a4 (patch)
tree49df98e4fb967d4112cc3096c6b256d67cc14210
parenta0cdd89a1e74f61c263bd7ee4b214d823b8e3a7c (diff)
Update ConnectedCouchDB.listUsersAndEmails() docstring.fix/update-docs
-rw-r--r--src/leap/mx/couchdb.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/leap/mx/couchdb.py b/src/leap/mx/couchdb.py
index fe46ac6..04cfc4d 100644
--- a/src/leap/mx/couchdb.py
+++ b/src/leap/mx/couchdb.py
@@ -109,12 +109,14 @@ class ConnectedCouchDB(client.CouchDB):
@defer.inlineCallbacks
def listUsersAndEmails(self, limit=1000, reverse=False):
- """
- List all users and email addresses, up to the given limit.
+ """List all users and email addresses, up to the given limit.
+
+ :param int limit: The number of results to limit the response to.
+ :param bool reverse: Start at the end of the database mapping.
"""
query = "/users/_design/User/_view/by_email_or_alias/?reduce=false"
answer = yield self.query(query, limit=limit, reverse=reverse)
-
+
if answer:
parsed = yield self.parseResult(answer)
if parsed: