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

docs: describe 3-level help paste hierarchy
Some checks failed
CI / gitleaks (push) Failing after 3s
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: add Detailed Help section with format example.
CHEATSHEET.md: note hierarchy layout in help description.
TASKS.md: update sprint with hierarchy task and test count.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
user
2026-02-23 23:22:49 +01:00
parent 20c1d738be
commit b658053711
3 changed files with 31 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
TASKS.md
View File

@@ -7,9 +7,10 @@
| 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] | 3-level hierarchy: plugin (col 0), command (indent 4), docstring (indent 8) |
| 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) |
| P1 | [x] | Helper functions: `_build_cmd_detail(indent=)`, `_paste` |
| P1 | [x] | Tests: 7 new cases in test_core.py (11 total) |
| P2 | [x] | Documentation update (USAGE.md, CHEATSHEET.md, TASKS.md) |
## Previous Sprint -- MusicBrainz Fallback (2026-02-23)