Skip to content

docs: align the reference pages with what the framework does - #3215

Merged
IvanKirpichnikov merged 5 commits into
mainfrom
docs/factual-fixes
Sep 21, 2026
Merged

IvanKirpichnikov merged 5 commits into
mainfrom
docs/factual-fixes

Conversation

@Lancetnik

@Lancetnik Lancetnik commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

Split out of #3124, on top of the grammar pass (#3214, merged). Also carries the healthcheks.md → healthchecks.md rename with a redirect stub at the old URL (#3216, merged into this branch).

Every hunk here changes a statement, an identifier or an example, so this is the PR to read against the source. 62 files against main. By theme:

  • Acknowledgement: Kafka/Confluent nack seeks the same consumer back instead of handing the message to another one; ack()/nack() are no-ops under ACK_FIRST; group_id is required for every other policy; SetupError fires when the subscriber is declared, not at startup; Redis streams with a consumer group are at-least-once; per-broker default policies; the shared no_ack include now describes AckPolicy.MANUAL.
  • Message objects: which fields live on the wrapper and which on raw_message (Kafka, Confluent); decoded_body is gone and committed is an AckStatus (Redis).
  • Examples that no longer run: faststream.rabbitmq → faststream.rabbit, @broker.handler → @broker.subscriber, Depends(cache=) → use_cache=, asyncapi_url → specification_url, HandlerNotFoundError → SubscriberNotFound, TestClient → the Test*Broker classes, the Kafka RPC how-to, Django asgi:application, datetime.UTC → timezone.utc, pel_testing.py include line ranges.
  • Statements: Kafka publisher key is a per-publisher default that publish() overrides; batch publishing is not atomic; the ASGI CLI runs on uvicorn's supervisor, not gunicorn; NATS pull subscribers use an anyio task group; NATS scheduling argument names and the one-pending-schedule-per-subject rule; MQTT version defaults to 5.0; Prometheus broker label values; Redis RPC goes through request().
  • Cleanup: the orphan dependencies/{class,global,sub,testing,yield}.md stubs, the pre-3.9 tab in the shared Annotated include, the >=0.4.0 install warning on the Confluent page.

Test plan

  • just docs-check on this branch

Lancetnik and others added 3 commits September 21, 2026 19:45
Language-only pass: articles, agreement, typos, punctuation, heading levels
and malformed code-fence attributes. No statement about the framework changes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…at the old URL

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Every hunk here changes a statement, an identifier or an example, so each one
needs a check against the source: ack semantics for Kafka/Confluent/Redis
streams, SetupError timing, message wrapper fields, removed or renamed API in
examples, the shared no_ack and Annotated includes, orphan dependency stubs.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation Confluent Issues related to `faststream.confluent` module AioKafka Issues related to `faststream.kafka` module NATS Issues related to `faststream.nats` module and NATS broker features Redis Issues related to `faststream.redis` module and Redis features Observability MQTT Issues related to `faststream.mqtt` module AsyncAPI Issues related to AsyncAPI specification generation labels Sep 21, 2026
@Lancetnik
Lancetnik marked this pull request as ready for review September 21, 2026 16:54
Base automatically changed from docs/grammar-pass to main September 21, 2026 19:32
@IvanKirpichnikov
IvanKirpichnikov dismissed their stale review September 21, 2026 19:32

The base branch was changed.

healthcheks.md stays a redirect stub: healthchecks.md already carries the
grammar edits from #3214.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Lancetnik added a commit that referenced this pull request Sep 21, 2026
…h stack when opening

#3215 was opened against main with only a "Stack 2/3" line in its body, so its
diff carried the grammar PR below it.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@IvanKirpichnikov
IvanKirpichnikov added this pull request to the merge queue Sep 21, 2026
Merged via the queue into main with commit 67c2905 Sep 21, 2026
30 checks passed
@IvanKirpichnikov
IvanKirpichnikov deleted the docs/factual-fixes branch September 21, 2026 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AioKafka Issues related to `faststream.kafka` module AsyncAPI Issues related to AsyncAPI specification generation Confluent Issues related to `faststream.confluent` module documentation Improvements or additions to documentation MQTT Issues related to `faststream.mqtt` module NATS Issues related to `faststream.nats` module and NATS broker features Observability Redis Issues related to `faststream.redis` module and Redis features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants