Fix duplicated workers docs by leynos · Pull Request #49 · leynos/wireframe

leynos · 2025-06-15T09:55:09Z

Summary

clean up workers method docs
mark doctest snippet as ignored

Testing

cargo clippy -- -D warnings
RUSTFLAGS="-D warnings" cargo test
markdownlint docs/*.md README.md CHANGELOG.md (fails: many warnings)

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

Summary by Sourcery

Clean up and consolidate server method documentation and mark code examples as ignored to prevent doctest warnings.

Bug Fixes:

Remove duplicated documentation comments for the workers method

Enhancements:

Refine and simplify doc comments for with_preamble and workers methods
Clamp worker count documentation to clarify minimum of one worker
Convert doc example snippets to use no_run instead of ignore

Documentation:

Update code examples with necessary imports and no_run tags
Remove redundant example blocks and streamline method descriptions

Summary by CodeRabbit

Documentation
- Improved documentation examples for server configuration methods to be more complete and idiomatic.
- Clarified doc comments for worker count settings, specifying behaviour and usage.
- Consolidated and streamlined example code and explanations for better readability.
- Updated example code attributes to better indicate their usage.

sourcery-ai · 2025-06-15T09:55:12Z

Reviewer's Guide

This PR refines the WireframeServer documentation by marking example snippets as no_run in doctests and consolidating duplicate workers method comments into a single, clear description that emphasizes its clamping behavior.

Class diagram for WireframeServer documentation updates

classDiagram
  class WireframeServer~F, Preamble~ {
    +with_preamble~T~() WireframeServer~F, T~
    +workers(count: usize) Self
    +worker_count() usize
  }

File-Level Changes

Change	Details	Files
Mark example code blocks as ignored in doctests	Changed code fences to `no_run</li><li>Added necessary imports to the examples</li><li>Replaced` ignore flags with no_run for consistency	`src/server.rs`
Consolidate and clarify `workers` method documentation	Removed redundant doc paragraphs and duplicate example blocks Streamlined description to highlight count clamping to at least one Updated example fence to ```no_run and simplified usage	`src/server.rs`

Possibly linked issues

#0: The PR consolidates the duplicated documentation for the workers method as described in 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 · 2025-06-15T09:55:14Z

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation for WireframeServer::with_preamble and the workers method in src/server.rs was revised for clarity and completeness. Example code was improved to be more idiomatic and runnable. Doc comments were consolidated, and redundant sections were removed. No functional code changes were made.

Changes

Files	Change Summary
src/server.rs	Improved and clarified documentation and examples for `with_preamble` and `workers` methods.

Possibly related PRs

Fix docs for WireframeServer::new #42: Updates documentation comments in src/server.rs for WireframeServer methods, similar in scope and intent.
Refine server new docs #43: Refines documentation for different WireframeServer methods, also focusing on clarity without code changes.
Fix doc examples and remove duplicate tests #25: Improves documentation examples in src/server.rs with explicit imports and example attribute changes.

Poem

In the warren of docs, I hopped with care,
Tidying comments here and there.
Examples now clear, concise, and neat,
With bincode and imports, they’re quite the treat!
No code was touched, just words refined—
A rabbit’s work, for peace of mind.
🐇✨

📜 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 368b5e5 and c087c8b.

📒 Files selected for processing (1)

src/server.rs (4 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 ✨

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

leynos · 2025-06-15T10:52:58Z

@sourcery-ai review

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 ✨

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

…-workers-method

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.

Consolidate workers method docs

31d86c5

leynos added the codex label Jun 15, 2025 — with ChatGPT Codex Connector

codescene-delta-analysis Bot approved these changes Jun 15, 2025

View reviewed changes

sourcery-ai Bot reviewed Jun 15, 2025

View reviewed changes

Fix doctest examples

324eca0

codescene-delta-analysis Bot approved these changes Jun 15, 2025

View reviewed changes

sourcery-ai Bot reviewed Jun 15, 2025

View reviewed changes

Merge branch 'main' into codex/consolidate-duplicated-doc-comments-in…

c087c8b

…-workers-method

leynos merged commit 826622f into main Jun 15, 2025
1 of 3 checks passed

leynos deleted the codex/consolidate-duplicated-doc-comments-in-workers-method branch June 15, 2025 11:03

codescene-delta-analysis Bot approved these changes Jun 15, 2025

View reviewed changes

Conversation

leynos commented Jun 15, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Summary by Sourcery

Summary by CodeRabbit

Uh oh!

sourcery-ai Bot commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class diagram for WireframeServer documentation updates

File-Level Changes

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

coderabbitai Bot commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

leynos commented Jun 15, 2025

Uh oh!

codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

leynos commented Jun 15, 2025 •

edited by coderabbitai Bot

Loading

sourcery-ai Bot commented Jun 15, 2025 •

edited

Loading

coderabbitai Bot commented Jun 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)