]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
docstring requested changes
authorjonathan vanasco <jonathan@2xlp.com>
Mon, 18 May 2020 16:45:05 +0000 (12:45 -0400)
committerjonathan vanasco <jonathan@2xlp.com>
Mon, 18 May 2020 16:45:05 +0000 (12:45 -0400)
doc/build/errors.rst

index 6b1b97ebb6e8ac91d6914a231f59ddc282c87062..9df68427be973b7fc9eb9f5b0c67cb8a98a877b5 100644 (file)
@@ -734,15 +734,21 @@ Mitigation of this error is via two general techniques:
   special directives like the :func:`.raiseload` option can ensure that
   systems don't call upon lazy loading when its not expected.
 
-Please note: the default setting of :paramref:`_sa.orm.session.Session.expire_on_commit`
-is `True`, which means SQLAlchemy will expire the instance and all loaded
-attributes when a `commit` occurs. When this happens, SQLAlchemy will need to
-query the database to refresh the instance and attributes.
-  
+  .. note:
+
+    The default setting of :paramref:`_sa.orm.session.Session.expire_on_commit`
+    is ``True``, which means SQLAlchemy will expire the instance and all loaded
+    attributes when a ``commit`` occurs. When this happens, SQLAlchemy will need to
+    query the database to refresh the instance and attributes.
+
+    See the section :ref:`session_committing` for further background on this.
+
   .. seealso::
 
     :ref:`loading_toplevel` - detailed documentation on eager loading and other
     relationship-oriented loading techniques
+    :ref:`session_committing` - background on session commit
+    :ref:`session_expire` - background on attrifbute expiry
 
 
 .. _error_7s2a: