wutta/wuttjamaican
3
0
Fork 0
Code Activity

docs: add glossary entry for 'spec'

Browse source
This commit is contained in:
Lance Edgar 2024-12-18 12:28:31 -06:00
parent 062da0685c
commit 87790bbb1a
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/glossary.rst
View file

@ -227,6 +227,21 @@ Glossary
:term:`config settings<config setting>`. See also :term:`config settings<config setting>`. See also
:doc:`narr/config/table`. :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 subcommand
A top-level :term:`command` may expose one or more subcommands, A top-level :term:`command` may expose one or more subcommands,
for the overall command line interface. Subcommands are usually for the overall command line interface. Subcommands are usually