Skip to content

docs: correct stale dependency and version references#710

Merged
wbarnha merged 2 commits into
masterfrom
claude/docs-fix-stale-refs
Jul 19, 2026
Merged

docs: correct stale dependency and version references#710
wbarnha merged 2 commits into
masterfrom
claude/docs-fix-stale-refs

Conversation

@wbarnha

@wbarnha wbarnha commented Jul 19, 2026

Copy link
Copy Markdown
Member

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

  • redis extra listed the deprecated aredis. The extra is backed by
    redis-py now (since Replace aredis with redis-py #635), so the Extensions table said the wrong library.
  • Python-version contradiction in "What do I need?". The sidebar claimed
    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.
  • Dropped two stale "Faust version 1.0" self-references (the requirements
    sidebar subtitle and the storage-driver section in the App user guide).

Completeness / freshness

  • Documented previously-undocumented install bundles: faust[ckafka]
    (confluent-kafka / confluent:// transport), faust[rocksdict] (RocksDB via
    the rocksdict bindings), and faust[prometheus] / faust[sentry] sensors.
  • Refreshed the docs copyright to 2026 and noted the faust-streaming
    project's continued maintenance (conf.py + copyright.rst).

The grid-table column widths are preserved (verified against the +---+
separators), and docs/conf.py byte-compiles.

Scope notes

🤖 Generated with Claude Code

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

codecov Bot commented Jul 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.15%. Comparing base (d95af52) to head (989ad6c).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- 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
@wbarnha
wbarnha merged commit ade8a09 into master Jul 19, 2026
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant