docs: state that PipeDecoder timestamps are seconds - #203
Open
xuanku-001 wants to merge 1 commit into
Open
xuanku-001 wants to merge 1 commit into
xuanku-001 wants to merge 1 commit into
Conversation
PipeDecoder time parameters (pair_window, eviction_ttl, eviction_interval) are already documented in seconds, but the timestamp passed to decode(msg, timestamp=...) and the README examples never stated the unit. Callers passing milliseconds break CPR pair matching and cache expiry silently (see issue junzis#201). - _pipe.py: document timestamp unit in PipeDecoder.decode docstring - README.md: annotate the timestamp examples (batch + streaming) Closes junzis#201
Author
|
AI-assistance disclosure (should have been in the PR body — apologizing for the omission): this contribution was produced with AI assistance — an agent ("Da Kang") running on an LLM inside a local agent harness with deterministic validation (source-read patch generation, py_compile checks). Happy to answer any questions about the process. |
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.
Summary
PipeDecodertime parameters (pair_window,eviction_ttl,eviction_interval) are already documented in seconds, but thetimestamppassed todecode(msg, timestamp=...)and the README examples never stated the unit. Callers passing milliseconds break CPR pair matching and cache expiry silently (reported in #201).Changes
src/pyModeS/_pipe.py: document thetimestampunit inPipeDecoder.decode()docstring (seconds on a consistent clock base — same base as pair window / TTLs)README.md: annotate the timestamp examples in both the batch-decode and streaming sectionsValidation
py_compilepassesCloses #201