username/derp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update help command docs for FlaskPaste detail pages
Some checks failed
CI / gitleaks (push) Failing after 4s
Details
CI / lint (push) Failing after 23s
Details
CI / test (3.11) (push) Has been skipped
Details
CI / test (3.12) (push) Has been skipped
Details
CI / test (3.13) (push) Has been skipped
Details
CI / build (push) Has been skipped
Details

Browse Source 
USAGE.md, CHEATSHEET.md, and TASKS.md updated to reflect enhanced
!help output that pastes detailed docstrings via FlaskPaste.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
user
2026-02-23 23:04:36 +01:00
parent 69976196cd
commit ef18915807
3 changed files with 24 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
TASKS.md
View File

@@ -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 <cmd>` pastes docstring detail via FlaskPaste, appends URL |
| P0 | [x] | `!help <plugin>` 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) |

10
docs/CHEATSHEET.md
View File

@@ -86,15 +86,19 @@ Profile data written on graceful shutdown when bot runs with `--cprofile`.
```
!ping # Pong
!help # List commands
!help <cmd> # Command help
!help <plugin> # Plugin description + commands
!help # List commands + paste full reference
!help <cmd> # Command help + paste docstring detail
!help <plugin> # Plugin info + paste command details
!version # Bot version
!uptime # Bot uptime
!echo <text> # 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
```

6
docs/USAGE.md
View File

@@ -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 <cmd>` | Show help for a specific command |
| `!help <plugin>` | Show plugin description and its commands |
| `!help` | List all commands + paste full reference |
| `!help <cmd>` | Show help + paste detailed docstring |
| `!help <plugin>` | Show plugin description + paste command details |
| `!version` | Show bot version |
| `!uptime` | Show how long the bot has been running |
| `!echo <text>` | Echo back text (example plugin) |