wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

docs: add basic docs for batch feature

Browse source
This commit is contained in:
Lance Edgar 2025-12-04 00:51:30 -06:00
parent 0b57ca6ec2
commit 1a3756f47c
6 changed files with 169 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/glossary.rst
View file

@ -77,16 +77,15 @@ Glossary
See also :class:`~wuttjamaican.auth.AuthHandler`.
batch
This refers to a process whereby bulk data operations may be
This refers to a feature whereby bulk data operations may be
performed, with preview and other tools to allow the user to
refine as needed before "executing" the batch.
refine as needed before "executing" the batch. For more info see
:doc:`narr/batch/index`.
The term "batch" may refer to such a feature overall, or the
:term:`data model` used, or the specific data for a single batch,
etc.
See also :term:`batch handler` and :term:`batch row`, and the
:class:`~wuttjamaican.db.model.batch.BatchMixin` base class.
etc. See also :term:`batch type`, :term:`batch handler` and
:term:`batch row`.
batch handler
This refers to a :term:`handler` meant to process a given type of
@ -94,7 +93,7 @@ Glossary
There may be multiple handlers registered for a given
:term:`batch type`, but (usually) only one will be configured for
use.
use. See also :doc:`narr/batch/handlers`.
batch row
A row of data within a :term:`batch`.