Skip to content

Commit

Permalink
fixes doc references.
Browse files Browse the repository at this point in the history
  • Loading branch information
peterschutt authored and provinzkraut committed Sep 30, 2023
1 parent 98000ea commit 3d1b551
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@
(PY_CLASS, "NoneType"),
(PY_CLASS, "litestar._openapi.schema_generation.schema.SchemaCreator"),
(PY_CLASS, "litestar._signature.model.SignatureModel"),
(PY_CLASS, "litestar.contrib.sqlalchemy.plugins.init.config.compat._CreateEngineMixin"),
(PY_CLASS, "litestar.utils.signature.ParsedSignature"),
(PY_CLASS, "litestar.utils.sync.AsyncCallable"),
# types in changelog that no longer exist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ Renaming the dependencies
#########################

You can change the name that the engine and session are bound to by setting the
:attr:`engine_dependency_key` and :attr:`session_dependency_key`
:attr:`engine_dependency_key <advanced_alchemy.extensions.litestar.plugins.init.config.asyncio.SQLAlchemyAsyncConfig.engine_dependency_key>`
and :attr:`session_dependency_key <advanced_alchemy.extensions.litestar.plugins.init.config.asyncio.SQLAlchemyAsyncConfig.session_dependency_key>`
attributes on the plugin configuration.

Configuring the before send handler
Expand All @@ -49,9 +50,9 @@ The plugin configures a ``before_send`` handler that is called before sending a
session and removes it from the connection scope.

You can change the handler by setting the
:attr:`before_send_handler` attribute
on the configuration object. For example, an alternate handler is available that will also commit the session on success
and rollback upon failure.
:attr:`before_send_handler <advanced_alchemy.extensions.litestar.plugins.init.config.asyncio.SQLAlchemyAsyncConfig.before_send_handler>`
attribute on the configuration object. For example, an alternate handler is available that will also commit the session
on success and rollback upon failure.

.. tab-set::

Expand Down

0 comments on commit 3d1b551

Please sign in to comment.