DOC-6827 Prepare Lettuce probabilistic data type docs#3610
Open
andy-stark-redis wants to merge 1 commit into
Open
DOC-6827 Prepare Lettuce probabilistic data type docs#3610andy-stark-redis wants to merge 1 commit into
andy-stark-redis wants to merge 1 commit into
Conversation
Stage Lettuce async + reactive doctests for the bloom, cuckoo, CMS, top-k, t-digest and HLL tutorial sets plus the combined home_prob_dts set, and add the client-specific rundown page at content/develop/clients/lettuce/prob.md. This is preemptive work: probabilistic command support is not in a released lettuce-core yet, so the examples are written against the Lettuce feature PRs (BF/CF/top-k merged to main; CMS and t-digest still open on the Dgramada fork, so their signatures may still shift). A Codex review flagged every non-HLL call as an unknown method - that is expected against the repo's pinned released jar, not a defect. Multi-step sets (t-digest, home_prob_dts) are authored as self-contained per-STEP blocks rather than one method chain threaded through the STEP markers, because the clients-example shortcode extracts each step by line range and a threaded chain renders as broken mid-chain fragments. Learned: multi-step doctests must be self-contained per STEP block or the shortcode extracts broken mid-chain fragments Constraint: each STEP_START/STEP_END block must stand alone (its own async chain, or per-statement reactive blocks), never span a single threaded method chain Rejected: one async/reactive chain threaded through all STEP markers | shortcode extracts per-step line ranges, so a threaded chain yields uncompilable fragments Recheck: when Lettuce CMS (redis/lettuce#3821) and t-digest (#3823) merge and release - re-pin lettuce-core, re-run the doctest harness so the REMOVE-block asserts become real oracles, and re-diff the CMS/t-digest signatures Ticket: DOC-6827 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Contributor
andy-stark-redis
added
the
parked
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
1 participant
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.
DOC-6827 — Lettuce probabilistic data type docs
Adds Lettuce (Java) coverage for the probabilistic data types, in two parts.
Examples
Staged Lettuce async + reactive doctests (
local_examples/<set>/lettuce-async|lettuce-reactive/) for:bf_tutorialcuckoo_tutorialcms_tutorialtopk_tutorialtdigest_tutorialhll_tutorialhome_prob_dtsThe per-type data-type pages embed
clients-examplewithout alang_filter, so the newJava-Async/Java-Reactivetabs appear automatically once the example pipeline regeneratesexamples.json— no edits to those pages needed.Rundown page
New
content/develop/clients/lettuce/prob.md, adapted from the Jedis page, withlang_filter="Java-Async,Java-Reactive".Probabilistic command support is not in a released
lettuce-coreyet. Examples are written against the Lettuce feature PRs:redis/lettucemain: BF (#3760), CF (#3774), Top-K (#3780)Dgramada/lettuce): CMS (#3821), t-digest (#3823) — signatures may still changeA Codex review flagged every non-HLL call as an unknown method; that's expected against the pinned released jar, not a defect. When the features release: re-pin
lettuce-core, re-run the doctest harness (the REMOVE-block asserts become real oracles then), and re-diff the CMS/t-digest signatures. CMS/t-digest are the higher-risk pair to re-verify.🤖 Generated with Claude Code
Note
Medium Risk
Documentation-only, but examples depend on probabilistic APIs not yet in released lettuce-core (especially CMS and t-digest), so CI or readers on the current jar may fail until dependencies and signatures are updated.
Overview
Adds Lettuce client documentation for Redis probabilistic data types: a new
content/develop/clients/lettuce/prob.mdoverview (mirroring other client prob pages) with embeddedclients-examplesnippets filtered to Java-Async and Java-Reactive.Introduces doctest-style Java examples under
local_examples/for Bloom filter, Cuckoo filter, Count-min sketch, Top-K, t-digest, HyperLogLog, plus a combinedhome_prob_dtsset—each in async and reactive variants usingSTEP_START/STEP_ENDmarkers for doc extraction.Examples call probabilistic commands on
RedisAsyncCommands/RedisReactiveCommands(e.g.bfReserve,cmsInitByProb,tdigestCreate,topKReserve) so Java-Async / Java-Reactive tabs can appear on existing data-type pages afterexamples.jsonregeneration, without editing those pages in this PR.Reviewed by Cursor Bugbot for commit 48553bc. Bugbot is set up for automated code reviews on this repo. Configure here.