docs(gui_2): Add SQLite-granularity docstrings for App init, run, _gui_func, and shutdown

This commit is contained in:
ed
2026-06-12 21:18:18 -04:00
parent f04aeaea65
commit 3b4b55698c
3 changed files with 78 additions and 17 deletions
@@ -19,15 +19,15 @@
# Phase 1: App Lifecycle & Setup
## Task 1.1: Document App class constructor and lifecycle entry points
- [ ] **Step 1: Document `App.__init__`**
- [x] **Step 1: Document `App.__init__`** (99e7b6e)
Add docstring detailing setup sequence (event listeners, thread initialization, window default states, preset loading).
- [ ] **Step 2: Document `App.run`**
- [x] **Step 2: Document `App.run`** (99e7b6e)
Add docstring detailing hello_imgui initialization, window setup, styling profile setup, and running loop entrance.
- [ ] **Step 3: Document `App._gui_func`**
- [x] **Step 3: Document `App._gui_func`** (99e7b6e)
Add docstring detailing main viewport render loop dispatch, hotkey intercepts (palette, reloading), layout presets, and viewport frame rendering. Include a high-level ASCII mockup of the entire dock layout.
- [ ] **Step 4: Document `App.shutdown`**
- [x] **Step 4: Document `App.shutdown`** (99e7b6e)
Add docstring detailing file cache flush, background worker termination, profile dump, and clean exit procedures.
- [ ] **Step 5: Verify syntax and run existing tests**
- [x] **Step 5: Verify syntax and run existing tests** (99e7b6e)
Run: `pytest tests/test_gui_window_controls.py`
Expected: Success.
@@ -19,8 +19,8 @@ phase_5 = { status = "pending", checkpoint_sha = "", name = "Diagnostics, Analyt
[tasks]
# Phase 1: App Lifecycle & Setup
t1_1 = { status = "pending", commit_sha = "", description = "Document App.__init__" }
t1_2 = { status = "pending", commit_sha = "", description = "Document App.run, _gui_func, shutdown" }
t1_1 = { status = "completed", commit_sha = "99e7b6e8", description = "Document App.__init__" }
t1_2 = { status = "completed", commit_sha = "99e7b6e8", description = "Document App.run, _gui_func, shutdown" }
t1_3 = { status = "pending", commit_sha = "", description = "Document App state preservation, undo/redo, profiles" }
# Phase 2: Discussion Panel & Controls