docs(adapters): fix stale CLAUDE.md details in kdb, otlp, prometheus#405
Open
0-jake-0 wants to merge 1 commit into
Open
docs(adapters): fix stale CLAUDE.md details in kdb, otlp, prometheus#4050-jake-0 wants to merge 1 commit into
0-jake-0 wants to merge 1 commit into
Conversation
Doc drift caught in the adapter compliance review — comments describing behavior the code no longer matches: - kdb: kdb_read_cached takes a `cache_config: CacheConfig` (folder + LRU size cap), not a `cache_dir: impl Into<PathBuf>`, and the cache *does* evict (LRU by max_size_bytes) rather than "persist until manually deleted — no TTL, no eviction". Update the description and the example snippet. - otlp: the integration-test collector image is pinned to 0.149.0, not the 0.116.0 the Gotchas section claimed. - prometheus: the per-metric slot is `Arc<ArcSwapOption<String>>`, not `Arc<ArcSwap<String>>` — note the None never-ticked sentinel. Docs only; no code or behavior change.
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
2 participants
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.
Part 4 of 4 from the adapter compliance review — low-severity doc drift where CLAUDE.md comments describe behavior the code no longer matches.
kdb —
kdb_read_cachedtakes acache_config: CacheConfig(folder + LRU size cap), not acache_dir: impl Into<PathBuf>, and the cache does evict (LRU bymax_size_bytes) rather than "persist until manually deleted — no TTL, no eviction". Updated the API description and the example snippet (now passesCacheConfig::new(...)). The mod.rs docs and example READMEs already described this correctly — only the adapter CLAUDE.md was stale.otlp — the integration-test collector image is pinned to
0.149.0(integration_tests.rs:26,mod.rs:9), not the0.116.0the Gotchas section claimed.prometheus — the per-metric slot is
Arc<ArcSwapOption<String>>(exporter.rs), notArc<ArcSwap<String>>; noted theNonenever-ticked sentinel that's skipped on scrape.Docs only — no code or behavior change. Verified no other occurrences of the stale strings remain in each adapter directory.
https://claude.ai/code/session_01JLqvwSW8V4xPpvxV1vwXuX
Generated by Claude Code