Skip to content

docs: update rustdoc documentation for v0.5.0#9

Merged
Berektassuly merged 1 commit intomainfrom
claude/update-rustdoc-chatpack-ysUw6
Dec 27, 2025
Merged

docs: update rustdoc documentation for v0.5.0#9
Berektassuly merged 1 commit intomainfrom
claude/update-rustdoc-chatpack-ysUw6

Conversation

@Berektassuly
Copy link
Copy Markdown
Owner

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).

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).
@Berektassuly Berektassuly merged commit 4bbbbfd into main Dec 27, 2025
8 checks passed
@Berektassuly Berektassuly deleted the claude/update-rustdoc-chatpack-ysUw6 branch December 27, 2025 19:36
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 85.71429% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/core/filter.rs 85.71% 2 Missing ⚠️

📢 Thoughts on this report? Let us know!

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.

3 participants