From bb8ff87c58e33cdba8fce542aa23d1910d8b3029 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Wed, 21 May 2025 15:09:18 -0400 Subject: [PATCH] document operations in terms of Operations Change-Id: I6d0da502bd39252c74a4c240b08530b9b2ebdc37 --- alembic/operations/base.py | 2 +- docs/build/ops.rst | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/alembic/operations/base.py b/alembic/operations/base.py index 9f975031..26c32724 100644 --- a/alembic/operations/base.py +++ b/alembic/operations/base.py @@ -464,7 +464,7 @@ class AbstractOperations(util.ModuleClsProxy): names will be converted along conventions. If the ``target_metadata`` contains the naming convention ``{"ck": "ck_bool_%(table_name)s_%(constraint_name)s"}``, then the - output of the following: + output of the following:: op.add_column("t", "x", Boolean(name="x")) diff --git a/docs/build/ops.rst b/docs/build/ops.rst index c8d6d771..8eb9bf70 100644 --- a/docs/build/ops.rst +++ b/docs/build/ops.rst @@ -41,11 +41,15 @@ method. .. module:: alembic.operations -.. autoclass:: AbstractOperations - :members: +.. class:: AbstractOperations + + Base class for :class:`.Operations` and :class:`.BatchOperations`. + + See :class:`.Operations` for full list of members .. autoclass:: Operations :members: + :inherited-members: .. autoclass:: BatchOperations - :members: \ No newline at end of file + :members: -- 2.47.3