From: Federico Caselli Date: Fri, 29 Dec 2023 23:14:39 +0000 (+0100) Subject: fix typo in session.reset docs X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=02472e8b65ac4062f2c3e7cee19608c801fba14c;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git fix typo in session.reset docs Change-Id: I6073cc623f216ffad8c18396001191b38eccc129 --- diff --git a/lib/sqlalchemy/orm/scoping.py b/lib/sqlalchemy/orm/scoping.py index f5f08c72f5..e720c7cebf 100644 --- a/lib/sqlalchemy/orm/scoping.py +++ b/lib/sqlalchemy/orm/scoping.py @@ -534,12 +534,12 @@ class scoped_session(Generic[_S]): behalf of the :class:`_orm.scoping.scoped_session` class. This method provides for same "reset-only" behavior that the - :meth:_orm.Session.close method has provided historically, where the + :meth:`_orm.Session.close` method has provided historically, where the state of the :class:`_orm.Session` is reset as though the object were brand new, and ready to be used again. - The method may then be useful for :class:`_orm.Session` objects + This method may then be useful for :class:`_orm.Session` objects which set :paramref:`_orm.Session.close_resets_only` to ``False``, - so that "reset only" behavior is still available from this method. + so that "reset only" behavior is still available. .. versionadded:: 2.0.22 diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py index 094e029ae7..643eee5d53 100644 --- a/lib/sqlalchemy/orm/session.py +++ b/lib/sqlalchemy/orm/session.py @@ -2472,12 +2472,12 @@ class Session(_SessionClassMethods, EventTarget): :class:`_orm.Session`, resetting the session to its initial state. This method provides for same "reset-only" behavior that the - :meth:_orm.Session.close method has provided historically, where the + :meth:`_orm.Session.close` method has provided historically, where the state of the :class:`_orm.Session` is reset as though the object were brand new, and ready to be used again. - The method may then be useful for :class:`_orm.Session` objects + This method may then be useful for :class:`_orm.Session` objects which set :paramref:`_orm.Session.close_resets_only` to ``False``, - so that "reset only" behavior is still available from this method. + so that "reset only" behavior is still available. .. versionadded:: 2.0.22