diff --git a/TASKS.md b/TASKS.md index 954c950..1c02743 100644 --- a/TASKS.md +++ b/TASKS.md @@ -1,6 +1,18 @@ # derp - Tasks -## Current Sprint -- MusicBrainz Fallback (2026-02-23) +## Current Sprint -- Enhanced Help with FlaskPaste (2026-02-23) + +| Pri | Status | Task | +|-----|--------|------| +| P0 | [x] | `!help ` pastes docstring detail via FlaskPaste, appends URL | +| P0 | [x] | `!help ` pastes all plugin command details | +| P0 | [x] | `!help` (no args) pastes full reference grouped by plugin | +| P1 | [x] | Graceful fallback when FlaskPaste not loaded or paste fails | +| P1 | [x] | Helper functions: `_build_cmd_detail`, `_paste` | +| P1 | [x] | Tests: 5 new cases in test_core.py (9 total) | +| P2 | [x] | Documentation update (USAGE.md, CHEATSHEET.md, TASKS.md) | + +## Previous Sprint -- MusicBrainz Fallback (2026-02-23) | Pri | Status | Task | |-----|--------|------| @@ -306,6 +318,7 @@ | Date | Task | |------|------| +| 2026-02-23 | Enhanced `!help` with FlaskPaste detail pages (docstrings, grouped reference) | | 2026-02-23 | MusicBrainz fallback for `!similar` and `!tags` (no Last.fm key required) | | 2026-02-22 | v2.3.0 (voice profiles, rubberband FX, multi-bot, self-mute, container tools) | | 2026-02-21 | v2.3.0 (pymumble rewrite, music playback, fades, seek, kept library) | diff --git a/docs/CHEATSHEET.md b/docs/CHEATSHEET.md index 482ef40..77c78a7 100644 --- a/docs/CHEATSHEET.md +++ b/docs/CHEATSHEET.md @@ -86,15 +86,19 @@ Profile data written on graceful shutdown when bot runs with `--cprofile`. ``` !ping # Pong -!help # List commands -!help # Command help -!help # Plugin description + commands +!help # List commands + paste full reference +!help # Command help + paste docstring detail +!help # Plugin info + paste command details !version # Bot version !uptime # Bot uptime !echo # Echo text back !h # Shorthand (any unambiguous prefix works) ``` +Detailed help output (docstrings, subcommands, examples) is pasted to +FlaskPaste and appended as a URL. Falls back gracefully if FlaskPaste +is not loaded. + ## Permission Tiers ``` diff --git a/docs/USAGE.md b/docs/USAGE.md index 10213b6..8831da7 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -124,9 +124,9 @@ unchanged. The server name is derived from the hostname automatically. | Command | Description | |---------|-------------| | `!ping` | Bot responds with "pong" | -| `!help` | List all available commands | -| `!help ` | Show help for a specific command | -| `!help ` | Show plugin description and its commands | +| `!help` | List all commands + paste full reference | +| `!help ` | Show help + paste detailed docstring | +| `!help ` | Show plugin description + paste command details | | `!version` | Show bot version | | `!uptime` | Show how long the bot has been running | | `!echo ` | Echo back text (example plugin) |