Update docstrings

aiohttp_sqlalchemy/decorators.py

@@ -10,7 +10,10 @@
 
 
 def sa_decorator(key: str = SA_DEFAULT_KEY) -> THandlerWrapper:
-    """SQLAlchemy asynchronous handler decorator."""
+    """SQLAlchemy asynchronous handler decorator.
+
+    :param key: key of SQLAlchemy binding. Has default.
+    """
 
     def wrapper(handler: THandler) -> THandler:
         @wraps(handler)

aiohttp_sqlalchemy/middlewares.py

@@ -6,7 +6,10 @@
 
 
 def sa_middleware(key: str = SA_DEFAULT_KEY) -> THandler:
-    """SQLAlchemy asynchronous middleware factory."""
+    """SQLAlchemy asynchronous middleware factory.
+
+    :param key: key of SQLAlchemy binding. Has default.
+    """
 
     @middleware
     async def sa_middleware_(request: Request, handler: THandler) -> StreamResponse:

aiohttp_sqlalchemy/utils.py

@@ -13,6 +13,12 @@ async def init_db(
     metadata: MetaData,
     key: str = SA_DEFAULT_KEY,
 ) -> None:
+    """Create all tables, indexes and etc.
+
+    :param app: instance of ``aiohttp.web_app.Application``.
+    :param metadata: instance of ``sqlalchemy.scql.schema.MetaData``.
+    :param key: key of SQLAlchemy binding. Has default.
+    """
     session_factory = sa_session_factory(app, key)
     async with session_factory() as session:
         async with session.bind.begin() as connection:
@@ -23,7 +29,11 @@ def sa_session(
     request: Request,
     key: str = SA_DEFAULT_KEY,
 ) -> AsyncSession:
-    """Return ``AsyncSession`` instance."""
+    """Return ``AsyncSession`` instance.
+
+    :param request: instance of ``aiohttp.web_request.Request``.
+    :param key: key of SQLAlchemy binding. Has default.
+    """
     if not isinstance(request, Request):
         raise TypeError(f"{request} is not {Request}.")
 
@@ -38,7 +48,12 @@ def sa_session_factory(
     source: Union[Request, Application],
     key: str = SA_DEFAULT_KEY,
 ) -> TSessionFactory:
-    """Return callable object which returns an ``AsyncSession`` instance."""
+    """Return callable object which returns an ``AsyncSession`` instance.
+
+    :param sorce: instance of ``aiohttp.web_request.Request`` or
+                  ``aiohttp.web_app.Application``.
+    :param key: key of SQLAlchemy binding. Has default.
+    """
     return cast(TSessionFactory, getattr(source, "app", source).get(key))