Refine server new docs

[leynos]

Summary

• remove the Panics section from WireframeServer::new

Testing

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

---

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

Summary by Sourcery

Refine the documentation for WireframeServer::new to clarify default behavior and usage and remove outdated sections.

Documentation:

• Simplify and rephrase the doc comments for WireframeServer::new.
• Remove the Panics section and redundant explanations from the method docs.
• Update the example code block to use no_run and highlight the need to call bind.

Summary by CodeRabbit

• Documentation
  • Simplified and condensed the documentation for the server initialisation process. No changes to functionality or public interfaces.

[sourcery-ai]

Reviewer's Guide

This PR refines the documentation for WireframeServer::new, removing outdated sections and streamlining descriptions around worker count, listener setup, and usage examples without altering any functionality.

Flow Diagram of Information in Updated WireframeServer::new Documentation

graph TD
    A["1. Purpose: Create `WireframeServer` from application factory"] --> B["2. Worker Count: Defaults to available CPU cores (or 1 if undetermined)"]
    B --> C["3. TCP Listener: Unset by `new()`. Must call `bind()` before running server"] 
    C --> D["4. Example: Provided (`no_run` attribute used)"]

Loading

File-Level Changes

Change	Details	Files
Refined doc comments for WireframeServer::new	Removed the # Panics section Simplified the function description phrasing Condensed worker count explanation into a single sentence Updated code example annotation from ignore to no_run Clarified TCP listener setup instruction	src/server.rs

Possibly linked issues

• #0: PR removes the outdated # Panics section from WireframeServer::new docs, directly addressing the issue.
• Create design roadmap for rust-binary-router-library #1: The PR consolidates and simplifies the WireframeServer::new documentation by removing duplication and the Panics section.

---

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]

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 32 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between f9724a2 and 0f36417.

📒 Files selected for processing (1)

• src/server.rs (1 hunks)

Walkthrough

The documentation comment for the WireframeServer::new constructor was simplified and condensed, removing detailed explanations, example code, and explicit panic conditions. No code or functional changes were made; only the doc comment was updated for brevity and clarity.

Changes

File(s)	Change Summary
src/server.rs	Simplified and condensed the documentation comment for WireframeServer::new; removed example and panic details.

Possibly related issues

• Docs: Remove misleading # Panics section from WireframeServer::new #20: This issue discusses removing outdated panic documentation from WireframeServer::new, which is addressed by the simplified doc comment in this PR.

Possibly related PRs

• Fix docs for WireframeServer::new #42: Also focuses on simplifying and correcting WireframeServer::new documentation comments.
• Add WireframeServer skeleton #6: Introduces the WireframeServer implementation and its public API, which this PR's doc changes reference.
• Fix compile errors and clippy #11: Adds a minimal example and updates documentation for WireframeServer::new, overlapping with this PR's documentation focus.

Poem

In the warren of code, a comment grew long,
But now it's concise, where it once did belong.
No panic, no sample, just clear as the sun—
The server awaits, its journey begun.
🐇✨

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

[leynos]

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

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