Skip to content

Commit a206229

Browse files
author
Joohwan Oh
committed
Update README.md
1 parent 574573d commit a206229

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ my_db.rename_collection("new_col", "my_col")
9292
# Remove a collection from the database
9393
my_db.remove_collection("my_col")
9494

95-
# Retrieve the collection information
95+
# Retrieve collection information
9696
my_col = a.db("my_db").collection("my_col")
9797
len(my_col) == my_col.count
9898
my_col.properties
@@ -131,7 +131,7 @@ my_col.contains("a_document_key")
131131
```python
132132
my_col = a.collection("my_col")
133133

134-
# List all the indexes in collection "my_col"
134+
# List the indexes in collection "my_col"
135135
my_col.indexes
136136

137137
# Add a unique hash index attributes "attr1" and "attr2"
@@ -231,7 +231,7 @@ my_graph.add_edge_definition(
231231
to_vertex_collections=["vcol02"],
232232
)
233233

234-
# Retrieve the graph information
234+
# Retrieve graph information
235235
my_graph.properties
236236
my_graph.id
237237
my_graph.revision
@@ -289,18 +289,18 @@ results = my_graph.execute_traversal(
289289
strategy="depthfirst"
290290
)
291291

292-
# Get the visited nodes in order
292+
# Return the visited nodes in order
293293
results.get("visited")
294294

295-
# Get the paths traversed
295+
# Return the paths traversed in order
296296
results.get("paths")
297297
```
298298

299299
## Batch Requests
300300
```python
301301
# NOTE: only (add/update/replace/remove) methods for (documents/vertices/edges) are supported at the moment
302302

303-
# Execute a batch documents request
303+
# Execute a batch request for managing documents
304304
my_db.execute_batch([
305305
(
306306
my_col.add_document, # method name
@@ -329,7 +329,7 @@ my_db.execute_batch([
329329
),
330330
])
331331

332-
# Execute a batch vertex requests
332+
# Execute a batch request for managing vertexes
333333
self.db.execute_batch([
334334
(
335335
my_graph.add_vertex,
@@ -362,7 +362,7 @@ action = """
362362
"""
363363
res = my_db.execute_transaction(
364364
action=action,
365-
read_collections=["col01","col02"],
365+
read_collections=["col01", "col02"],
366366
write_collections=["col01", "col02"],
367367
wait_for_sync=True,
368368
lock_timeout=10000
@@ -379,7 +379,7 @@ res = my_db.execute_transaction(
379379
7. Misc. Functions
380380
8. General Handling
381381

382-
## Running System Tests (requires ArangoDB on localhost)
382+
## Running Tests (requires ArangoDB on localhost)
383383
```bash
384384
nosetests
385385
```

0 commit comments

Comments
 (0)