Fix doctest compilation

[leynos]

Summary

• update doctest in Message::from_bytes
• fix read_preamble example
• correct server documentation imports

Testing

• cargo clippy -- -D warnings
• RUSTFLAGS="-D warnings" cargo test --all-targets --quiet

---

https://chatgpt.com/codex/tasks/task_e_684ea4e943e88322b167ab01130e17b5

Summary by Sourcery

Fix compilation errors in doctest examples across message, server, and preamble modules by updating annotations, imports, and trait derives to ensure the examples compile successfully.

Documentation:

• Mark the Message::from_bytes example as no_run, add bincode::Encode and bincode::BorrowDecode derives, and use a valid placeholder byte vector.
• Add missing wireframe::app::WireframeApp import in server examples and adjust import paths for Preamble and process_stream.
• Import read_preamble and add bincode::Encode derive to MyPreamble in the preamble example.

Summary by CodeRabbit

• Documentation
  • Improved and clarified example code in documentation comments, including updated import statements, struct definitions, and code formatting for better accuracy and readability.
  • Adjusted code examples to prevent compiler warnings and ensure consistency across documentation.

[sourcery-ai]

Reviewer's Guide

The pull request enhances documentation examples and doctests across the codebase by adding missing imports and derives, enabling no-run tests, and adjusting code snippets so that doctests compile cleanly.

File-Level Changes

Change	Details	Files
Revise Message::from_bytes doctest to compile under no_run	Add no_run flag to the code block Derive both bincode::Encode and bincode::BorrowDecode on the example struct Replace comment placeholder with vec![]; for serialized bytes Use an underscore prefix for the unused msg variable	src/message.rs
Fix server documentation imports and examples	Import WireframeApp in server examples Adjust import paths for Preamble and process_stream Replace unimplemented stream placeholder with unimplemented!() call	src/server.rs
Correct preamble example imports and derives	Import read_preamble instead of bare bincode::BorrowDecode Add bincode::Encode to the example struct’s derives	src/preamble.rs

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The updates revise documentation examples across multiple modules, improving code clarity and correctness. Changes include refining imports, struct definitions, trait derivations, and variable naming within doc comments. No implementation logic or public API signatures are altered; all modifications are limited to documentation examples.

Changes

File(s)	Change Summary
src/message.rs	Updated doc example for from_bytes: added struct definition, changed code block type, renamed variable.
src/preamble.rs	Revised doc example for read_preamble: updated imports, added trait derivation to struct.
src/server.rs	Improved doc examples: corrected imports, clarified code, replaced placeholder with unimplemented!().

Possibly related PRs

• Fix doc examples and remove duplicate tests #25: Updates to documentation examples in src/server.rs and other modules, focusing on import corrections and clarity.
• Fix doctest compilation #51: Similar updates to documentation examples in src/message.rs, src/preamble.rs, and src/server.rs to fix doctest compilation and improve example imports.
• Refine server new docs #43: Documentation improvements for WireframeServer::new examples, complementing the current PR’s focus on example code clarity.

Poem

A rabbit with docs on its mind,
Tidied imports and structs you’ll find.
Examples now shine,
With code more divine,
And warnings are left far behind!

🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14cc6d7 and abf3882.

📒 Files selected for processing (1)

• src/server.rs (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codescene-delta-analysis]

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Absence of Expected Change Pattern

• wireframe/src/server.rs is usually changed with: wireframe/src/extractor.rs, wireframe/src/middleware.rs

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

[sourcery-ai]

Hey @leynos - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codescene-delta-analysis]

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Absence of Expected Change Pattern

• wireframe/src/server.rs is usually changed with: wireframe/src/extractor.rs, wireframe/src/middleware.rs

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.