diff options
Diffstat (limited to 'dev-docs/alfred.md')
| -rw-r--r-- | dev-docs/alfred.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/dev-docs/alfred.md b/dev-docs/alfred.md index 49e2a08..07708b1 100644 --- a/dev-docs/alfred.md +++ b/dev-docs/alfred.md @@ -17,7 +17,7 @@ it manages are also Sopel instances, each with their own configs. Alfred's directory contains multiple .py files, each loaded as an independent Sopel plugin module. Sopel loads them individually (not as a package), so relative imports do not work. Modules that need shared data use a sys.path -insertion to import `helpstrings` as a plain module — see the Help system +insertion to import `helpstrings` as a plain module; see the Help system section below. ``` @@ -69,14 +69,14 @@ args) and `help.py` uses the same strings for `!help srv` responses. !help <topic> <cmd> → single command description + usage ``` -All responses are sent via `bot.notice()` to the requester — not said publicly +All responses are sent via `bot.notice()` to the requester, not said publicly in channel. This matches the osterman and jeeves help behaviour. ### Dispatch `help.py` delegates all resolution to `h.lookup(args)` in `helpstrings.py`. `helpstrings.py` exposes `TOPIC_MAP`, `_ALL`, and `lookup()` alongside the -existing string constants — the same pattern used by osterman and jeeves. +existing string constants; the same pattern used by osterman and jeeves. Unknown args fall back to the TOPICS line with a "no help for X" prefix. ### Bare-call consistency @@ -89,7 +89,7 @@ USAGE lists that previously existed in each plugin have been removed. `!help bot <name>` where `<name>` is not `list` or `all` falls back to `h.BOT_NAME`, the generic bot-name description. This is handled inside -`h.lookup()` — not in `help.py` — since managed bot names are dynamic and +`h.lookup()`, not in `help.py`, since managed bot names are dynamic and not enumerable at help-text definition time. ### coffee +n / -n lookup |