From e532a2c2084b3acddc3ce4e837711d5b2f6b0702 Mon Sep 17 00:00:00 2001 From: Roman Druzhkov Date: Sun, 16 Jun 2024 14:48:30 -0400 Subject: [PATCH] Correct 'Session.is_modified' method documentation Correct 'Session.is_modified' method documentation. ### Description Correct documentation according to discussion: https://github.com/sqlalchemy/sqlalchemy/discussions/11481#discussioncomment-9759171 ### Checklist This pull request is: - [x] A documentation / typographical / small typing error fix - Good to go, no issue or tests are needed - [ ] A short code fix - please include the issue number, and create an issue if none exists, which must include a complete example of the issue. one line code fixes without an issue and demonstration will not be accepted. - Please include: `Fixes: #` in the commit message - please include tests. one line code fixes without tests will not be accepted. - [ ] A new feature implementation - please include the issue number, and create an issue if none exists, which must include a complete example of how the feature would look. - Please include: `Fixes: #` in the commit message - please include tests. **Have a nice day!** Closes: #11501 Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/11501 Pull-request-sha: 16e949af544b4a1a94ccc5660e164fd2bca8be78 Change-Id: Ia8be0e3865190f0667de006c3006ecf646ef8422 (cherry picked from commit 30492d665ed7edc474d151f0854ed4837dcafaed) --- lib/sqlalchemy/ext/asyncio/scoping.py | 2 +- lib/sqlalchemy/ext/asyncio/session.py | 2 +- lib/sqlalchemy/orm/scoping.py | 2 +- lib/sqlalchemy/orm/session.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/sqlalchemy/ext/asyncio/scoping.py b/lib/sqlalchemy/ext/asyncio/scoping.py index 8fdb5a7c6d..39731c47fb 100644 --- a/lib/sqlalchemy/ext/asyncio/scoping.py +++ b/lib/sqlalchemy/ext/asyncio/scoping.py @@ -868,7 +868,7 @@ class async_scoped_session(Generic[_AS]): This method retrieves the history for each instrumented attribute on the instance and performs a comparison of the current - value to its previously committed value, if any. + value to its previously flushed or committed value, if any. It is in effect a more expensive and accurate version of checking for the given instance in the diff --git a/lib/sqlalchemy/ext/asyncio/session.py b/lib/sqlalchemy/ext/asyncio/session.py index 87f1a8c977..4ff21c5d23 100644 --- a/lib/sqlalchemy/ext/asyncio/session.py +++ b/lib/sqlalchemy/ext/asyncio/session.py @@ -1310,7 +1310,7 @@ class AsyncSession(ReversibleProxy[Session]): This method retrieves the history for each instrumented attribute on the instance and performs a comparison of the current - value to its previously committed value, if any. + value to its previously flushed or committed value, if any. It is in effect a more expensive and accurate version of checking for the given instance in the diff --git a/lib/sqlalchemy/orm/scoping.py b/lib/sqlalchemy/orm/scoping.py index ca8fdc95e5..d333f174a5 100644 --- a/lib/sqlalchemy/orm/scoping.py +++ b/lib/sqlalchemy/orm/scoping.py @@ -1233,7 +1233,7 @@ class scoped_session(Generic[_S]): This method retrieves the history for each instrumented attribute on the instance and performs a comparison of the current - value to its previously committed value, if any. + value to its previously flushed or committed value, if any. It is in effect a more expensive and accurate version of checking for the given instance in the diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py index 77f4471218..c495a964f3 100644 --- a/lib/sqlalchemy/orm/session.py +++ b/lib/sqlalchemy/orm/session.py @@ -4778,7 +4778,7 @@ class Session(_SessionClassMethods, EventTarget): This method retrieves the history for each instrumented attribute on the instance and performs a comparison of the current - value to its previously committed value, if any. + value to its previously flushed or committed value, if any. It is in effect a more expensive and accurate version of checking for the given instance in the -- 2.47.2