wutta/wuttjamaican
3
0
Fork 0
Code Activity

docs: improve doc for wuttjamaican.db.model

Browse source
This commit is contained in:
Lance Edgar 2024-12-07 18:54:25 -06:00
parent 1debacd160
commit ed5e886a5d
1 changed files with 6 additions and 2 deletions

8
src/wuttjamaican/db/model/__init__.py
View file

@ -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 <data model>`:
* :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