From 87790bbb1a53719767e334193de36700afb6085a Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Wed, 18 Dec 2024 12:28:31 -0600 Subject: [PATCH] docs: add glossary entry for 'spec' --- docs/glossary.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/glossary.rst b/docs/glossary.rst index 58484a2..dd3768f 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -227,6 +227,21 @@ Glossary :term:`config settings`. See also :doc:`narr/config/table`. + spec + As the term is used in Wutta Project context, this refers to a + string designating the import path to a particular object (class, + function etc.). + + Also the term implies a certain format, namely a dotted module + path followed by colon (``:``), then object name. + + For instance, ``wuttjamaican.app:AppHandler`` is the spec string + for the :class:`wuttjamaican.app.AppHandler` class (and note, the + hyperlink does not use colon, but our "spec" always does). + + See also :meth:`~wuttjamaican.app.AppHandler.load_object()` (on + the :term:`app handler`) which can return any object from spec. + subcommand A top-level :term:`command` may expose one or more subcommands, for the overall command line interface. Subcommands are usually