Skip to content

Commit 647eb6e

Browse files
committed
docs: qualify the transport cleanup claim in the API reference
`close()` / `aclose()` release the wrapped transport unconditionally, but close breakers only when the transport owns the registry — an injected one stays open for its owner to close. The httpx2/httpx sections of the reference stated the unqualified version; the integration pages already carried the caveat.
1 parent 274df1b commit 647eb6e

2 files changed

Lines changed: 12 additions & 8 deletions

File tree

‎docs/llms-full.txt‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4517,8 +4517,9 @@ Extra `interlock-cb[httpx2]`, module `interlock.integrations.httpx2`:
45174517
via `excluded_exceptions`.
45184518

45194519
Both transports expose their per-host `registry` and the guarded transport as a
4520-
read-only `wrapped`; `close()` / `aclose()` release the wrapped transport and
4521-
every breaker in that registry. See the
4520+
read-only `wrapped`. `close()` / `aclose()` release the wrapped transport and,
4521+
when the transport owns the registry, every breaker in it; a caller-owned
4522+
registry stays open and is closed by its owner. See the
45224523
[httpx2 integration](integrations/httpx2.md).
45234524

45244525
## httpx adapters
@@ -4534,8 +4535,9 @@ Extra `interlock-cb[httpx]` (httpx ≥ 0.27.0), module
45344535
`LocalProtocolError` exclusions.
45354536

45364537
Both transports expose their per-host `registry` and the guarded transport as a
4537-
read-only `wrapped`, preserve streaming responses, and release the wrapped
4538-
transport and every breaker on `close()` / `aclose()`.
4538+
read-only `wrapped`, and preserve streaming responses. `close()` / `aclose()`
4539+
release the wrapped transport and, when the transport owns the registry, every
4540+
breaker in it; a caller-owned registry stays open and is closed by its owner.
45394541
See the [httpx integration](integrations/httpx.md).
45404542

45414543
## aiohttp adapters

‎docs/reference.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,9 @@ Extra `interlock-cb[httpx2]`, module `interlock.integrations.httpx2`:
197197
via `excluded_exceptions`.
198198

199199
Both transports expose their per-host `registry` and the guarded transport as a
200-
read-only `wrapped`; `close()` / `aclose()` release the wrapped transport and
201-
every breaker in that registry. See the
200+
read-only `wrapped`. `close()` / `aclose()` release the wrapped transport and,
201+
when the transport owns the registry, every breaker in it; a caller-owned
202+
registry stays open and is closed by its owner. See the
202203
[httpx2 integration](integrations/httpx2.md).
203204

204205
## httpx adapters
@@ -214,8 +215,9 @@ Extra `interlock-cb[httpx]` (httpx ≥ 0.27.0), module
214215
`LocalProtocolError` exclusions.
215216

216217
Both transports expose their per-host `registry` and the guarded transport as a
217-
read-only `wrapped`, preserve streaming responses, and release the wrapped
218-
transport and every breaker on `close()` / `aclose()`.
218+
read-only `wrapped`, and preserve streaming responses. `close()` / `aclose()`
219+
release the wrapped transport and, when the transport owns the registry, every
220+
breaker in it; a caller-owned registry stays open and is closed by its owner.
219221
See the [httpx integration](integrations/httpx.md).
220222

221223
## aiohttp adapters

0 commit comments

Comments
 (0)