Skip to content

Commit b3d400d

Browse files
lesnik512claude
andcommitted
docs: repoint dead planning/specs docstring references
Six module docstrings cited planning/specs/2026-06-*.md, a directory that no longer exists; repoint them to the living architecture/ truth home. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 7242928 commit b3d400d

6 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎src/httpware/_internal/observability.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Observability emission helper — structured logging + opt-in OpenTelemetry span events.
22
3-
See planning/specs/2026-06-05-observability-design.md for the contract.
3+
See architecture/resilience.md (Observability section) for the contract.
44
55
Logger names (``httpware.retry``, ``httpware.bulkhead``, ``httpware.circuit_breaker``,
66
``httpware.timeout``) and event names (``retry.giving_up``, ``bulkhead.rejected``,

‎src/httpware/client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1118,7 +1118,7 @@ async def stream( # noqa: PLR0913, C901 — mirrors httpx2 per-method signature
11181118
is closed when the context exits.
11191119
11201120
Bypasses the middleware chain (no AsyncRetry, no AsyncBulkhead, no user-installed
1121-
middleware) for v1 — see planning/specs/2026-06-05-streaming-design.md.
1121+
middleware) for v1 — see architecture/client.md for the contract.
11221122
11231123
Auto-raises StatusError subclasses on 4xx/5xx (NotFoundError,
11241124
ServiceUnavailableError, etc.) — consistent with client.get()/post()/etc.

‎src/httpware/middleware/resilience/budget.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Finagle-style token-bucket retry budget.
22
3-
See planning/specs/2026-06-05-retry-and-retry-budget-design.md for the contract.
3+
See architecture/resilience.md (Retry + RetryBudget section) for the contract.
44
55
Thread-safe and asyncio-safe: all mutations go through a threading.Lock,
66
which ensures no torn state across concurrent accesses. When a RetryBudget

‎src/httpware/middleware/resilience/bulkhead.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""AsyncBulkhead middleware — concurrency limiter via asyncio.Semaphore.
22
3-
See planning/specs/2026-06-05-bulkhead-design.md for the contract.
3+
See architecture/resilience.md (Bulkhead section) for the contract.
44
55
The middleware owns an asyncio.Semaphore(max_concurrent). On each request,
66
it acquires a slot (bounded by acquire_timeout via asyncio.timeout) and

‎src/httpware/middleware/resilience/circuit_breaker.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""CircuitBreaker + AsyncCircuitBreaker — consecutive-failure and failure-rate circuit breakers.
22
3-
See planning/specs/2026-06-13-circuit-breaker-and-timeout-design.md for the contract.
3+
See architecture/resilience.md (CircuitBreaker + AsyncTimeout section) for the contract.
44
55
A counted failure is a NetworkError, an httpware TimeoutError, or a StatusError whose
66
status_code is in the effective failure set (default: all 5xx). 4xx — including 429 —

‎src/httpware/middleware/resilience/retry.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""AsyncRetry + Retry middleware — automatic retry of transient failures with budget control.
22
3-
See planning/specs/2026-06-05-retry-and-retry-budget-design.md for the full contract.
3+
See architecture/resilience.md (Retry + RetryBudget section) for the full contract.
44
55
Status-code retry: the client terminal raises StatusError subclasses on 4xx/5xx,
66
so the retry middleware catches StatusError and inspects exc.response.status_code. The

0 commit comments

Comments
 (0)