Skip to content

Commit da5d308

Browse files
committed
Update docstring for ArangoClient.verify method
1 parent 6c06d82 commit da5d308

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

arango/client.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ class ArangoClient(object):
2424
:param username: ArangoDB username (default: ``"root"``)
2525
:type username: str | unicode
2626
:param password: ArangoDB password (default: ``""``)
27-
:param verify: check the connection during initialization
27+
:param verify: check the connection during initialization. Root privileges
28+
are required to use this check.
2829
:type verify: bool
2930
:param http_client: the HTTP client object
3031
:type http_client: arango.http_clients.base.BaseHTTPClient
@@ -83,6 +84,10 @@ def verify(self):
8384
:rtype: bool
8485
:raises arango.exceptions.ServerConnectionError: if the connection to
8586
the ArangoDB server fails
87+
88+
.. note::
89+
Root privileges (i.e. access to the ``_system`` database) are
90+
required to use this method.
8691
"""
8792
res = self._conn.head('/_api/version')
8893
if res.status_code not in HTTP_OK:

arango/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
VERSION = '3.7.0'
1+
VERSION = '3.7.1'

0 commit comments

Comments
 (0)