ed/manual_slop
Private
Public Access
0
0
Fork 0
Code Activity

docs(guides): fix vendor_capabilities.py, mma_exec.py, audit_optional_returns drift

Browse Source 
- Readme.md AI Client row: '5 providers' -> 8; added VendorCapabilities
  inlining note + Result[str] send() API note.
- guide_ai_client.md: src/vendor_capabilities.py refs -> src/ai_client.py
  #region: Vendor Capabilities (2 sites: the capabilities param
  comment + the V2 Capability Matrix section).
- docs/AGENTS.md: audit_optional_returns.py -> audit_optional_in_3_files.py
  (the live script; the successor is not yet built).
- guide_mma.md SubConversationRunner sketch: 'Reuses mma_exec.py' ->
  'Would reuse the WorkerPool internal subprocess template (NOT the
  deprecated mma_exec.py)'.
- guide_multi_agent_conductor.md: architecture diagram box
  'Workers call mma_exec.py' -> 'Workers run via the internal
  subprocess template (run_worker_lifecycle; NOT the deprecated
  meta-tooling mma_exec.py)'; the mma_exec.py box relabeled to
  run_worker_lifecycle; See Also 'scripts/mma_exec.py — sub-agent
  entry point' -> 'src/multi_agent_conductor.py:run_worker_lifecycle
  (NOT the deprecated meta-tooling mma_exec.py)'.
This commit is contained in:
ed
2026-07-02 19:39:43 -04:00
parent 3423cc35a0
commit 444ee13f7f
5 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/AGENTS.md
+2 -2
View File
@@ -34,7 +34,7 @@ The canonical mandate is in [`conductor/code_styleguides/data_oriented_design.md
4. **The enforcement audit scripts** — the project-level enforcement set:
- `scripts/audit_weak_types.py --strict` — flags `dict[str, Any]`, `Any`, anonymous tuples
- `scripts/audit_optional_returns.py --strict` — flags `Optional[T]` return types in ALL `src/*.py` (post-2026-06-27 successor to `audit_optional_in_3_files.py`)
- `scripts/audit_optional_in_3_files.py --strict` — flags `Optional[T]` return types in the 4 baseline refactored files (`src/mcp_client.py`, `src/ai_client.py`, `src/rag_engine.py`, plus one more). An all-`src/*.py` successor (`audit_optional_returns.py`) is referenced in older planning docs but is NOT yet built — the live script today is `audit_optional_in_3_files.py`.
- `scripts/audit_exception_handling.py --strict` — the data-oriented error handling convention
- `scripts/audit_main_thread_imports.py` — always strict; the import graph gate
- `scripts/audit_no_models_config_io.py` — the config-I/O ownership gate
@@ -45,7 +45,7 @@ The canonical mandate is in [`conductor/code_styleguides/data_oriented_design.md
```bash
# Run before claiming "done"
uv run python scripts/audit_weak_types.py
uv run python scripts/audit_optional_returns.py
uv run python scripts/audit_optional_in_3_files.py
uv run python scripts/audit_exception_handling.py
uv run python scripts/audit_main_thread_imports.py
uv run python scripts/audit_no_models_config_io.py