From b7ddfae3370ffd4cd602f15cec35ec7870b830d1 Mon Sep 17 00:00:00 2001
From: Yusur Princeps <sakuragasaki46@gmail.com>
Date: Thu, 4 Sep 2025 09:36:35 +0200
Subject: [PATCH] add docstring to SQLAlchemy(), version advance

---
 CHANGELOG.md                 |  9 +++++++++
 src/suou/__init__.py         |  2 +-
 src/suou/sqlalchemy_async.py | 13 +++++++++++--
 3 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3e60ffb..99233d4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.6.0
+
+👀
+
+## 0.5.3
+
+- Added docstring to `SQLAlchemy()`.
+- More type fixes.
+
 ## 0.5.2
 
 - Fixed poorly handled merge conflict leaving `.sqlalchemy` modulem unusable
diff --git a/src/suou/__init__.py b/src/suou/__init__.py
index ac4ddaa..12d272d 100644
--- a/src/suou/__init__.py
+++ b/src/suou/__init__.py
@@ -34,7 +34,7 @@ from .validators import matches
 from .redact import redact_url_password
 from .http import WantsContentType
 
-__version__ = "0.5.3-dev34"
+__version__ = "0.5.3"
 
 __all__ = (
     'ConfigOptions', 'ConfigParserConfigSource', 'ConfigSource', 'ConfigValue',
diff --git a/src/suou/sqlalchemy_async.py b/src/suou/sqlalchemy_async.py
index 575f239..6f7e996 100644
--- a/src/suou/sqlalchemy_async.py
+++ b/src/suou/sqlalchemy_async.py
@@ -29,8 +29,17 @@ from suou.exceptions import NotFoundError
 
 class SQLAlchemy:
     """
-    Drop-in (?) replacement for flask_sqlalchemy.SQLAlchemy()
-    eligible for async environments
+    Drop-in (in fact, almost) replacement for flask_sqlalchemy.SQLAlchemy()
+    eligible for async environments.
+
+    Notable changes:
+    + You have to create the session yourself. Easiest use case:
+
+    async def handler (userid):
+        async with db as session:
+            # do something
+            user = (await session.execute(select(User).where(User.id == userid))).scalar()
+            # ...
 
     NEW 0.5.0
     """