| 1 | # document_query.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `document_query.py` helper module. |
| 6 | - This module provides compatibility exports for document query behavior. |
| 7 | - Keep this file-level DOX profile synchronized with `document_query.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `document_query.py` owns the runtime implementation. |
| 12 | - `document_query.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | |
| 14 | ## Runtime Contracts |
| 15 | |
| 16 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 17 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 18 | - Observed side-effect areas: plugin state. |
| 19 | - Imported dependency areas include: `plugins._document_query.helpers.document_query`. |
| 20 | |
| 21 | ## Key Concepts |
| 22 | |
| 23 | - This module is primarily declarative or delegates behavior through classes/imported objects. |
| 24 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 25 | |
| 26 | ## Work Guidance |
| 27 | |
| 28 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 29 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 30 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 31 | |
| 32 | ## Verification |
| 33 | |
| 34 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 35 | - Related tests observed by source search: |
| 36 | - `tests/test_document_query_fallback.py` |
| 37 | - `tests/test_document_query_plugin.py` |
| 38 | |
| 39 | ## Child DOX Index |
| 40 | |
| 41 | No child DOX files. |