Skip to content

Commit 711be8d

Browse files
committed
Update documentation
1 parent c6ebe4a commit 711be8d

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

docs/client.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ and used:
4242
result = db.aql.execute('FOR s IN students RETURN s')
4343
print([student['name'] for student in result])
4444
45-
Pretty simple right? Read the rest of the documentation to discover much more!
45+
Read the rest of the documentation to discover much more!

docs/database.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Databases
55

66
A single ArangoDB instance can house multiple databases, which in turn contain
77
their own set of worker processes, :ref:`collections <collection-page>`, and
8-
:ref:`graphs <graph-page>`. There must always be a default database named
9-
``_system``. This database cannot be dropped, can only be accessed with root
8+
:ref:`graphs <graph-page>`. There is always a default database named ``_system``.
9+
This default database cannot be dropped, can only be accessed with root
1010
privileges, and provides operations for managing other user-defined databases.
1111

12-
Here is an example showing how databases can be managed with different users:
12+
Here is an example showing how databases can be managed with multiple users:
1313

1414
.. code-block:: python
1515
@@ -41,7 +41,7 @@ Here is an example showing how databases can be managed with different users:
4141
4242
# To switch to a different user, simply create a new database object with
4343
# the credentials of the desired user (which in this case would be jane's)
44-
db = client.database('another_database', username='jane', password='bar')
44+
db = client.database('another_database', username='jane', password='foo')
4545
4646
# Delete an existing database as root
4747
client.delete_database('another_database')

docs/document.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Documents
55

66
**Documents** in python-arango are Python dictionaries. They can be nested to
77
an arbitrary depth and contain lists. Each document must have the ``"_key"``
8-
field, whose value identifies the document uniquely within a given collection.
9-
There is also the ``"_id"`` field, whose value identifies the document uniquely
10-
across *all* collections within a given database.
8+
field, whose value identifies the document uniquely within a collection. There
9+
is also the ``"_id"`` field, whose value identifies the document uniquely across
10+
*all* collections within a database.
1111

1212
ArangoDB supports MVCC (Multiple Version Concurrency Control) and is capable
13-
of storing each document in multiple revisions. The revision of a document can
14-
be distinguished by the value of the ``"_rev"`` field. For more information on
15-
document basics and terminologies visit this
13+
of storing each document in multiple revisions. The revision of a document is
14+
distinguished by the value of the ``"_rev"`` field. For more information on
15+
documents and their associated terminologies visit this
1616
`page <https://docs.arangodb.com/HTTP/Document/AddressAndEtag.html>`__.
1717

1818
Here is an example of a valid document:
@@ -28,7 +28,7 @@ Here is an example of a valid document:
2828
'address': {
2929
'city': 'Gotham',
3030
'zip': 'M1NS93',
31-
'street' : '300 Beverly St.',
31+
'street' : '300 Beverly St.'
3232
},
3333
'courses': ['CSC101', 'STA101']
3434
}
@@ -37,7 +37,7 @@ Here is an example of a valid document:
3737

3838
**Edge documents** or **edges** are similar to documents but with additional
3939
required fields ``"_from"`` and ``"_to"``. The values of these fields are the
40-
values of the ``"_id"`` field in the "from" and "to" vertex documents (see
40+
values of the ``"_id"`` field of the "from" and "to" vertex documents (see
4141
:ref:`graphs <graph-page>` for more details). Edge documents are contained in
4242
:ref:`edge collections <edge-collections>`.
4343

@@ -52,7 +52,7 @@ Here is an example of a valid edge document:
5252
'_from': 'students/john',
5353
'_to': 'students/jane',
5454
'friends': True,
55-
'closeness': 10
55+
'family': False
5656
}
5757
5858

docs/errors.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ which lightly wraps around the HTTP error responses returned from ArangoDB.
66
The majority of the error messages in the exceptions raised by python-arango
77
come directly from the server.
88

9-
Here is an example showing how a python-arango exception can be caught:
9+
Here is an example showing how a python-arango exception can be handled:
1010

1111
.. code-block:: python
1212

docs/graph.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Graphs
44
------
55

6-
An **graph** consists of **vertices** and **edges**. Edges are stored as
6+
A **graph** consists of **vertices** and **edges**. Edges are stored as
77
documents in :ref:`edge collections <edge-collections>`, whereas vertices
88
are stored as documents in :ref:`vertex collections <vertex-collections>`
99
(edges can be vertices also). The combination of edge and vertex collections
@@ -144,7 +144,7 @@ Refer to :ref:`Graph` and :ref:`EdgeCollection` classes for more details.
144144
Graph Traversals
145145
================
146146

147-
**Graph traversals** can executed via the :func:`~arango.graph.Graph.traverse`
147+
**Graph traversals** are executed via the :func:`~arango.graph.Graph.traverse`
148148
method. A traversal can span across multiple vertex collections and walk over
149149
the documents in a variety of ways.
150150

docs/logging.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Logging
44
-------
55

6-
By default, :class:`arango.ArangoClient` logs API call history using the
6+
By default, :class:`arango.ArangoClient` records API call history using the
77
``arango`` logger at ``logging.DEBUG`` level.
88

99
Here is an example showing how the logger can be enabled and customized:
@@ -19,7 +19,7 @@ Here is an example showing how the logger can be enabled and customized:
1919
# Set the logging level
2020
logger.setLevel(logging.DEBUG)
2121
22-
# Attach a custom handler
22+
# Attach a handler
2323
handler = logging.StreamHandler()
2424
formatter = logging.Formatter('[%(levelname)s] %(message)s')
2525
handler.setFormatter(formatter)

0 commit comments

Comments
 (0)