Skip to content

Commit 5f0ee2c

Browse files
committed
minor docs changes
1 parent 2f46ee1 commit 5f0ee2c

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/reference/gqlalchemy/connection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ class _RoutedTransaction()
8181
The object handed to an ``execute_read`` / ``execute_write`` work function.
8282

8383
Wraps the pymgclient cursor of a managed transaction and exposes the same
84-
``execute`` / ``execute_and_fetch`` surface as :class:`MemgraphConnection`,
84+
``execute`` / ``execute_and_fetch`` surface as ``class MemgraphConnection()``,
8585
converting rows to gqlalchemy values. The surrounding transaction is managed
8686
by the router (begun, committed and retried around the work), so the work
8787
must not commit or roll back itself.

docs/reference/gqlalchemy/vendors/memgraph.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Runs ``work(tx)`` as a managed write against the main.
102102
The router wraps the work in a transaction, commits it, and retries
103103
transient failover conditions (with a routing refresh and capped
104104
exponential backoff). Because the work may run more than once, make it
105-
idempotent (e.g. ``MERGE`` rather than ``CREATE``). Requires routing=True.
105+
idempotent (e.g. ``MERGE`` rather than ``CREATE``). Requires ``routing=True``.
106106
107107
#### execute\_read
108108

@@ -112,7 +112,7 @@ def execute_read(work)
112112

113113
Runs ``work(tx)`` as a managed read against a replica.
114114

115-
Same retry semantics as :meth:`execute_write`. Requires routing=True.
115+
Same retry semantics as :meth:`execute_write`. Requires ``routing=True``.
116116

117117
#### get\_routing\_table
118118

@@ -121,7 +121,7 @@ def get_routing_table()
121121
```
122122

123123
Returns a snapshot of the cluster routing table as a dict with
124-
``ttl``, ``write``, ``read`` and ``route`` entries. Requires routing=True.
124+
``ttl``, ``write``, ``read`` and ``route`` entries. Requires ``routing=True``.
125125

126126
#### create\_stream
127127

gqlalchemy/connection.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ class _RoutedTransaction:
141141
"""The object handed to an ``execute_read`` / ``execute_write`` work function.
142142
143143
Wraps the pymgclient cursor of a managed transaction and exposes the same
144-
``execute`` / ``execute_and_fetch`` surface as :class:`MemgraphConnection`,
144+
``execute`` / ``execute_and_fetch`` surface as ``class MemgraphConnection()``,
145145
converting rows to gqlalchemy values. The surrounding transaction is managed
146146
by the router (begun, committed and retried around the work), so the work
147147
must not commit or roll back itself.

gqlalchemy/vendors/memgraph.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,15 +287,15 @@ def execute_write(self, work):
287287
The router wraps the work in a transaction, commits it, and retries
288288
transient failover conditions (with a routing refresh and capped
289289
exponential backoff). Because the work may run more than once, make it
290-
idempotent (e.g. ``MERGE`` rather than ``CREATE``). Requires routing=True.
290+
idempotent (e.g. ``MERGE`` rather than ``CREATE``). Requires ``routing=True``.
291291
"""
292292
router = self._get_router()
293293
return self._run_managed(router.execute_write, work)
294294

295295
def execute_read(self, work):
296296
"""Runs ``work(tx)`` as a managed read against a replica.
297297
298-
Same retry semantics as :meth:`execute_write`. Requires routing=True.
298+
Same retry semantics as :meth:`execute_write`. Requires ``routing=True``.
299299
"""
300300
router = self._get_router()
301301
return self._run_managed(router.execute_read, work)
@@ -306,7 +306,7 @@ def _run_managed(self, run, work):
306306

307307
def get_routing_table(self):
308308
"""Returns a snapshot of the cluster routing table as a dict with
309-
``ttl``, ``write``, ``read`` and ``route`` entries. Requires routing=True.
309+
``ttl``, ``write``, ``read`` and ``route`` entries. Requires ``routing=True``.
310310
"""
311311
return self._get_router().routing_table
312312

0 commit comments

Comments
 (0)