From: jonathan vanasco Date: Mon, 18 May 2020 16:45:05 +0000 (-0400) Subject: docstring requested changes X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2f977385680afdd7973a6790298978ecf9d22946;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git docstring requested changes --- diff --git a/doc/build/errors.rst b/doc/build/errors.rst index 6b1b97ebb6..9df68427be 100644 --- a/doc/build/errors.rst +++ b/doc/build/errors.rst @@ -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: