summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/base.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2019-01-15 16:12:39 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2019-01-15 16:14:01 -0500
commit26a8e46527b6443839044855a920ec1f298b03c8 (patch)
tree10a674830d087c243d9ebd8e045625867636aabd /lib/sqlalchemy/engine/base.py
parente1b299df819bc1a48ed565bd6efa8ee406ea7efa (diff)
downloadsqlalchemy-26a8e46527b6443839044855a920ec1f298b03c8.tar.gz
Convert most "See also" phrases into .. seealso::
Change-Id: Ie32598b895c1c5f5bce7c8e1573abbcfe9d434a8 (cherry picked from commit e81d3815abb36c52b0019dee6e4f67990e3d1c7d)
Diffstat (limited to 'lib/sqlalchemy/engine/base.py')
-rw-r--r--lib/sqlalchemy/engine/base.py44
1 files changed, 28 insertions, 16 deletions
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 2b7c3f86e..91accd9ec 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -609,14 +609,14 @@ class Connection(Connectable):
:class:`.Transaction` objects will roll back the
transaction.
- See also:
+ .. seealso::
- :meth:`.Connection.begin_nested` - use a SAVEPOINT
+ :meth:`.Connection.begin_nested` - use a SAVEPOINT
- :meth:`.Connection.begin_twophase` - use a two phase /XID transaction
+ :meth:`.Connection.begin_twophase` - use a two phase /XID transaction
- :meth:`.Engine.begin` - context manager available from
- :class:`.Engine`.
+ :meth:`.Engine.begin` - context manager available from
+ :class:`.Engine`
"""
if self.__branch_from:
@@ -639,8 +639,12 @@ class Connection(Connectable):
still controls the overall ``commit`` or ``rollback`` of the
transaction of a whole.
- See also :meth:`.Connection.begin`,
- :meth:`.Connection.begin_twophase`.
+ .. seealso::
+
+ :meth:`.Connection.begin`
+
+ :meth:`.Connection.begin_twophase`
+
"""
if self.__branch_from:
return self.__branch_from.begin_nested()
@@ -663,8 +667,11 @@ class Connection(Connectable):
:param xid: the two phase transaction id. If not supplied, a
random id will be generated.
- See also :meth:`.Connection.begin`,
- :meth:`.Connection.begin_twophase`.
+ .. seealso::
+
+ :meth:`.Connection.begin`
+
+ :meth:`.Connection.begin_twophase`
"""
@@ -1553,7 +1560,7 @@ class Connection(Connectable):
with engine.begin() as conn:
conn.execute("some statement", {'x':5, 'y':10})
- See also:
+ .. seealso::
:meth:`.Engine.begin` - engine-level transactional
context
@@ -1643,8 +1650,13 @@ class Transaction(object):
The Transaction object is **not** threadsafe.
- See also: :meth:`.Connection.begin`, :meth:`.Connection.begin_twophase`,
- :meth:`.Connection.begin_nested`.
+ .. seealso::
+
+ :meth:`.Connection.begin`
+
+ :meth:`.Connection.begin_twophase`
+
+ :meth:`.Connection.begin_nested`
.. index::
single: thread safety; Transaction
@@ -1797,11 +1809,11 @@ class Engine(Connectable, log.Identified):
An :class:`.Engine` object is instantiated publicly using the
:func:`~sqlalchemy.create_engine` function.
- See also:
+ .. seealso::
- :doc:`/core/engines`
+ :doc:`/core/engines`
- :ref:`connections_toplevel`
+ :ref:`connections_toplevel`
"""
@@ -2082,7 +2094,7 @@ class Engine(Connectable, log.Identified):
with engine.begin() as conn:
conn.execute("some statement", {'x':5, 'y':10})
- See also:
+ .. seealso::
:meth:`.Engine.begin` - engine-level transactional
context