docs: correct stale dependency and version references#710
Merged
Conversation
The user-facing docs still carried robinhood-era and pre-0.12 details: - `redis` extra listed the long-deprecated `aredis`; it is backed by `redis-py` now (since #635). - The "What do I need?" sidebar claimed Python 3.8 while the prose right below it already says 3.10 (the real minimum) - align it to 3.10. - Dropped two stale "Faust version 1.0" self-references. - Document the `faust[ckafka]` bundle (confluent-kafka / `confluent://` transport), which had no mention in the install docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #710 +/- ##
=======================================
Coverage 94.15% 94.15%
=======================================
Files 104 104
Lines 11136 11136
Branches 1201 1201
=======================================
Hits 10485 10485
Misses 550 550
Partials 101 101 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
- Bump the docs copyright to 2026 and note the faust-streaming project's continued maintenance (docs/conf.py and copyright.rst). - Document the install bundles that existed but were undocumented: `faust[rocksdict]` (Stores), and `faust[prometheus]` / `faust[sentry]` (Sensors). Left `aerospike` out on purpose: it ships a requirements file but is not in setup.py's BUNDLES, so `faust[aerospike]` is not an installable extra. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes stale references in the user-facing docs surfaced while auditing the
GitHub Pages docs for the 0.12 line. All changes are documentation-only.
Correctness fixes
redisextra listed the deprecatedaredis. The extra is backed byredis-pynow (since Replace aredis with redis-py #635), so the Extensions table said the wrong library.Python 3.8 or later while the prose immediately below already states the
real minimum, Python 3.10 or later. Aligned the sidebar to 3.10.
sidebar subtitle and the storage-driver section in the App user guide).
Completeness / freshness
faust[ckafka](confluent-kafka /
confluent://transport),faust[rocksdict](RocksDB viathe
rocksdictbindings), andfaust[prometheus]/faust[sentry]sensors.project's continued maintenance (
conf.py+copyright.rst).The grid-table column widths are preserved (verified against the
+---+separators), and
docs/conf.pybyte-compiles.Scope notes
setup.py'sBUNDLESandrequirements/extras/.aerospikeis intentionally omitted — it ships arequirements file but is not in
BUNDLES, sofaust[aerospike]is not aninstallable extra.
history/changelogs and the auto-generatedreference/API docswere intentionally left untouched — they document past releases.
opentracing/opentelemetryextras are not documented here becausethose extras don't exist on
masteryet (their PRs Remove dead opentracing reference from the confluent driver #685/Make opentracing an optional dependency (faust[opentracing]) #686/Add optional faust[opentelemetry] extra + docs for OpenTelemetry via the OpenTracing shim #688 are stillopen); documenting them now would be inaccurate. They can be added when those
land.
🤖 Generated with Claude Code