]> 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)
committersqla-tester <sqla-tester@sqlalchemy.org>
Sun, 16 Jun 2024 18:48:30 +0000 (14:48 -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

lib/sqlalchemy/ext/asyncio/scoping.py
lib/sqlalchemy/ext/asyncio/session.py
lib/sqlalchemy/orm/scoping.py
lib/sqlalchemy/orm/session.py

index e879a1654e976db26e2bab6c5f9a0750cde13436..162f34eabfcf19c322d4c90957cb1e34066af9fb 100644 (file)
@@ -864,7 +864,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 c5fe469a0d4f25ab05332dfc80fd8316b92a140e..473a8c1717c9111d4bca8ff63547bed373b9ae4d 100644 (file)
@@ -1307,7 +1307,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 819616ae85f3429f8c77b20cc16adc0a8d449697..283f4a0221fb2960a8055c54c0fa3b747a2824f5 100644 (file)
@@ -1228,7 +1228,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 a4bf7c1cecf46f87dfd8348e64e1de6d858fecfc..c455ffac93046264d279971f9e41048f1535c48e 100644 (file)
@@ -4761,7 +4761,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