docs: update rustdoc documentation for v0.5.0#9
Merged
Berektassuly merged 1 commit intomainfrom Dec 27, 2025
Merged
Conversation
Comprehensive documentation update for docs.rs: - lib.rs: Add overview, quick start, core concepts, common patterns, module structure, feature flags table, and serialization section - parser.rs: Improve Parser trait and Platform enum docs with examples - message.rs: Add field tables, construction examples, serialization info - core/models.rs: Document OutputConfig with usage examples - core/filter.rs: Add FilterConfig methods with_date_from/with_date_to/with_sender - core/processor.rs: Document merge_consecutive with compression examples - core/output/*.rs: Improve CSV/JSON/JSONL writer docs with format specs - streaming/*.rs: Document StreamingParser, MessageIterator, StreamingConfig - parsers/*.rs: Add platform-specific format details and examples All doc-tests pass (cargo test --doc).
|
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
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.
Comprehensive documentation update for docs.rs:
All doc-tests pass (cargo test --doc).