wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

docs: clarify glossary for app name

Browse source
This commit is contained in:
Lance Edgar 2024-12-07 22:18:05 -06:00
parent efb78a6635
commit 6a471b87c2
1 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/glossary.rst
View file

@ -43,16 +43,19 @@ Glossary
models<data model>` used by the :term:`app`.
app name
Code-friendly name for the underlying app/config system
(e.g. ``wutta_poser``).
This refers to the canonical name for the underlying app/config
system. It does not refer to the overall app; contrast with
:term:`app title`.
This must usually be specified as part of the call to
:func:`~wuttjamaican.conf.make_config()` and is then available on
the :term:`config object`
:attr:`~wuttjamaican.conf.WuttaConfig.appname` and the :term:`app
handler` :attr:`~wuttjamaican.app.AppHandler.appname`.
In most cases (i.e. by default) this will simply be ``wutta``.
This value affects the naming conventions for config files as
well as setting names etc.
See also the human-friendly :term:`app title`.
The primary reason for this abstraction is so that the Rattail
Project could leverage the Wutta config logic without having to
rewrite all config files in the wild.
See also :attr:`~wuttjamaican.conf.WuttaConfig.appname`.
app provider
A :term:`provider` which pertains to the :term:`app handler`.
@ -61,7 +64,8 @@ Glossary
app title
Human-friendly name for the :term:`app` (e.g. "Wutta Poser").
See also the code-friendly :term:`app name`.
See also the :term:`app name` which serves a very different
purpose.
auth handler
A :term:`handler` responsible for user authentication and