Fix doc examples and remove duplicate tests

[leynos]

Summary

• deduplicate payload tests in extractor.rs
• update doc comments to use no_run and include necessary imports
• fix example in middleware docs

Testing

• cargo clippy -- -D warnings
• RUSTFLAGS="-D warnings" cargo test
• markdownlint README.md docs/*.md (fails: many pre-existing issues)
• nixie docs/*

---

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

Summary by Sourcery

Clean up documentation examples by converting code blocks to no_run, adding necessary imports, and fixing the middleware example, and remove duplicate payload tests in the extractor.

Enhancements:

• Deduplicate and remove redundant payload tests in extractor.rs

Documentation:

• Convert doc code blocks in server.rs and middleware.rs from ignore to no_run
• Add required use statements to code examples in server and middleware docs
• Fix the middleware example to reference correct types (ServiceResponse) in docs
• Adjust SharedState example in extractor.rs to clone state consistently

Summary by CodeRabbit

• Documentation

  • Improved and clarified example code in documentation, including explicit imports and usage annotations for better guidance.
  • Enhanced server and middleware documentation with realistic initialisation patterns and updated code block attributes.

• Tests

  • Removed internal unit tests for payload handling.

[sourcery-ai]

Reviewer's Guide

This PR standardizes documentation examples across the codebase—switching fences to no_run, adding missing imports, and correcting example snippets in server, middleware, and extractor modules—and removes redundant payload tests in extractor.rs.

Class Diagram: Removal of Test Module from extractor.rs

classDiagram
  class TestModule_in_extractor_rs {
    <<Removed>>
    # Test Module
    +advance_consumes_bytes()
    +remaining_reports_length()
  }

Loading

File-Level Changes

Change	Details	Files
Standardize and update doc examples with no_run blocks and necessary imports	Replaced generic or ignore code fences with no_run Added use wireframe::{…} and other imports to all doc samples Corrected example snippets for factory closures and unwrap calls Harmonized SharedState example to use state.clone() consistently	src/server.rs src/middleware.rs src/extractor.rs
Remove duplicate payload tests	Deleted redundant advance_consumes_bytes and remaining_reports_length tests	src/extractor.rs

Possibly linked issues

• 📝 Add docstrings to codex/define-ddlog-types-for-positions,-blocks,-and-slopes #18: PR updates middleware examples to use 'wireframe' instead of 'your_crate', fixing the issue.

---

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]

Walkthrough

The changes remove the test module for the Payload struct in src/extractor.rs, update documentation examples in src/middleware.rs to clarify imports and async usage, and revise documentation in src/server.rs with improved example code and usage patterns. No runtime logic or public API was modified.

Changes

File(s)	Change Summary
src/extractor.rs	Removed the entire test module, including two unit tests for the Payload struct's advance and remaining methods.
src/middleware.rs	Updated documentation examples to include explicit imports and async trait usage for clarity.
src/server.rs	Revised documentation comments to improve example code, add explicit imports, and use no_run for code blocks.

Possibly related PRs

• Update roadmap and fix doc comments #23: Removes duplicate tests for the Payload struct in src/extractor.rs, directly related to the removal of redundant tests in this PR.
• Fix worker count default #16: Adds a duplicate test module for Payload in src/extractor.rs, modifying the same code as this PR but in the opposite direction.
• Implement trait foundations #8: Introduces the original unit tests for the Payload struct in src/extractor.rs, which are now being removed in this PR.

Poem

A rabbit hopped through docs and code,
Tidying tests from the old abode.
Imports now clear, examples refined,
Async traits and closures aligned.
With every hop, the comments grew bright—
Code and docs now look just right!
🐇✨

---

📜 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 f3eaf74 and 76aa508.

📒 Files selected for processing (3)

• src/extractor.rs (0 hunks)
• src/middleware.rs (1 hunks)
• src/server.rs (6 hunks)

💤 Files with no reviewable changes (1)

• src/extractor.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: coverage

🔇 Additional comments (6)

src/middleware.rs (2)

31-32: Add explicit imports for the example to compile
Including async_trait and the middleware types ensures the snippet builds without errors.

---

34-34: Annotate the Service impl with #[async_trait]
This clarifies the use of the async trait and is required for the example to compile.

src/server.rs (4)

57-58: Include WireframeApp and WireframeServer imports in the new example
This makes the code block self-contained and compilable.

---

78-80: Convert the workers example to no_run and add imports
Switching to no_run enables compile-only checks, and the explicit imports ensure it builds.

---

141-145: Use no_run for the bind example and import all types
This change compiles the snippet without executing it and provides all necessary use statements.

---

184-191: Update the run example to no_run with correct imports
The snippet now compiles as-is and clearly shows async usage with the required imports.

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

[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.}