docs(hallways): correct col contract in compute_hallways_for_wing docstring (#1680)

The docstring still said col "must support .get(where=..., include=...)",
but this PR changed the fetch to count() + paginated
get(limit=, offset=, include=) filtered client-side, precisely to avoid the
get(where=...) path that overflows SQLite's variable limit on large wings.

Update the Args entry to describe the real contract so fake collections and
alternate backends implement the right shape.

Docstring only — no behavior change.
This commit is contained in:
Milla J 2026-06-02 21:56:29 -07:00
parent af2bd0e10a
commit 300e824e94
1 changed files with 6 additions and 1 deletions

View File

@ -179,7 +179,12 @@ def compute_hallways_for_wing(
Args:
wing: wing name to scan.
col: ChromaDB collection must support ``.get(where=..., include=...)``.
col: ChromaDB collection must support ``.count()`` and paginated
``.get(limit=..., offset=..., include=...)``. The fetch is filtered
to ``wing`` client-side rather than via ``.get(where={"wing": ...})``,
which binds one SQL variable per matched id and overflows SQLite's
``SQLITE_MAX_VARIABLE_NUMBER`` on large wings (#1619). Fake
collections and alternate backends must implement this shape.
If ``None``, returns ``[]`` (caller didn't supply a backing
store, so nothing to compute against). Tests pass a controlled
MagicMock.