]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Correct 'Session.is_modified' method documentation
authorRoman Druzhkov <r.druzhkov99@gmail.com>
Sun, 16 Jun 2024 18:48:30 +0000 (14:48 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Tue, 18 Jun 2024 16:29:27 +0000 (12:29 -0400)
Correct 'Session.is_modified' method documentation.

<!-- Provide a general summary of your proposed changes in the Title field above -->

### Description
Correct documentation according to discussion: https://github.com/sqlalchemy/sqlalchemy/discussions/11481#discussioncomment-9759171

### Checklist
<!-- go over following points. check them with an `x` if they do apply, (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once)

-->

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: #<issue number>` 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: #<issue number>` 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
lib/sqlalchemy/ext/asyncio/session.py
lib/sqlalchemy/orm/scoping.py
lib/sqlalchemy/orm/session.py

index 8fdb5a7c6dbebd532bd444f149bb778d65180e67..39731c47fb88093bc8f32d8561b4c7d772f8d516 100644 (file)
@@ -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
index 87f1a8c977137fcd7511b31bccbce0b4737170f0..4ff21c5d2356461917fad441183f18b63e76731e 100644 (file)
@@ -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
index ca8fdc95e5b52d163b529d2309d74c2556f033b3..d333f174a51feae684cde90853e9ad76825fb801 100644 (file)
@@ -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
index 77f4471218ecf1d13fedd02949358d367c38aecb..c495a964f3e656adb007a8a19c9a0a5b0777b9e8 100644 (file)
@@ -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