diff --git a/docs/glossary.rst b/docs/glossary.rst index 2eab2c6..ff4cb73 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -43,16 +43,19 @@ Glossary models` 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