From ed5e886a5d765af3d53864403f28a12b879f95c6 Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Sat, 7 Dec 2024 18:54:25 -0600 Subject: [PATCH] docs: improve doc for `wuttjamaican.db.model` --- src/wuttjamaican/db/model/__init__.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/wuttjamaican/db/model/__init__.py b/src/wuttjamaican/db/model/__init__.py index d623775..b0c5255 100644 --- a/src/wuttjamaican/db/model/__init__.py +++ b/src/wuttjamaican/db/model/__init__.py @@ -25,9 +25,14 @@ Data Models This is the default :term:`app model` module. -The ``wuttjamaican.db.model`` namespace contains the following: +This namespace exposes the following: * :class:`~wuttjamaican.db.model.base.Base` +* :func:`~wuttjamaican.db.util.uuid_column()` +* :func:`~wuttjamaican.db.util.uuid_fk_column()` + +And the :term:`data models `: + * :class:`~wuttjamaican.db.model.base.Setting` * :class:`~wuttjamaican.db.model.base.Person` * :class:`~wuttjamaican.db.model.auth.Role` @@ -37,7 +42,6 @@ The ``wuttjamaican.db.model`` namespace contains the following: * :class:`~wuttjamaican.db.model.upgrades.Upgrade` """ -# TODO: remove these from wuttjamaican.db.util import uuid_column, uuid_fk_column from .base import Base, Setting, Person