]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Fix typo in Session.get_one() docs
authorJens Troeger <jens.troeger@light-speed.de>
Sat, 7 Oct 2023 06:48:29 +0000 (02:48 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Tue, 10 Oct 2023 00:23:29 +0000 (20:23 -0400)
<!-- Provide a general summary of your proposed changes in the Title field above -->

A typo in the docstrings [here](https://docs.sqlalchemy.org/en/20/orm/session_api.html#sqlalchemy.orm.Session.get_one) shows the incorrectly formatted text:

![Screenshot 2023-10-07 at 16 24 19](https://github.com/sqlalchemy/sqlalchemy/assets/12053937/95cbfbfa-dac3-465a-8e27-ec8e2a223117)

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: #10437
Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/10437
Pull-request-sha: 82ef25ecbc5b39487b5b55bedb43df9c2a57ae2e

Change-Id: I4ae54733c4bd63239fc94a7fd2099bb3896718ca

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

index 3c7a159acf270cc69e8ac0c7a44cacc7d8adc4b7..c03cfe8d54b99d2638813c8daafbb3c5d21a5a9f 100644 (file)
@@ -1097,7 +1097,7 @@ class scoped_session(Generic[_S]):
         For a detailed documentation of the arguments see the
         method :meth:`.Session.get`.
 
-        ..versionadded: 2.0.22
+        .. versionadded:: 2.0.22
 
         :return: The object instance, or ``None``.
 
index 1b48b90150ee48c3576022e5414a9ca3c055f93d..7f77a9bb77a6186712d1c8c3ea7f96176a203b27 100644 (file)
@@ -3671,7 +3671,7 @@ class Session(_SessionClassMethods, EventTarget):
         For a detailed documentation of the arguments see the
         method :meth:`.Session.get`.
 
-        ..versionadded: 2.0.22
+        .. versionadded:: 2.0.22
 
         :return: The object instance, or ``None``.