Fix rustdoc link warnings #316
Conversation
Summary by CodeRabbit
WalkthroughSummarise documentation link/reference updates across app, extractor, hooks, server, and session modules; expose MAX_PUSH_RATE as a public constant in src/push.rs. Do not change runtime logic, control flow, or type signatures elsewhere. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (8)
🧰 Additional context used📓 Path-based instructions (2)**/*.rs📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
⚙️ CodeRabbit Configuration File
Files:
{src,tests}/**/*.rs📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
🔍 Remote MCP (Deepwiki)Here are some concrete details to help verify the PR’s doc‐link fixes:
These confirm that all updated intra-doc links point to existing, correctly-scoped items and that making ⏰ Context from checks skipped due to timeout of 120000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (9)
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR resolves rustdoc link warnings by updating intra-doc references across modules (app, extractor, server, session, hooks, config) to fully qualified paths and exposes the previously private MAX_PUSH_RATE constant as a public API for documentation consistency. Class diagram for the updated PushQueues constantsclassDiagram
class PushQueues {
}
class MAX_PUSH_RATE {
<<constant>>
+MAX_PUSH_RATE: usize
}
PushQueues ..> MAX_PUSH_RATE : uses
Class diagram for updated doc references in WireframeApp and MessageRequestclassDiagram
class WireframeApp {
+handle_connection()
+app_data<T>(state: T) -> Self
}
class MessageRequest {
+peer_addr: SocketAddr
+state: WireframeApp
}
MessageRequest ..> WireframeApp : accesses state
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes and found some issues that need to be addressed.
Blocking issues:
- The module does not begin with a
//!comment as required by the instructions. (link) - The module does not begin with a
//!comment as required by the instructions. (link) - The module does not begin with a
//!comment as required by the instructions. (link) - The module does not begin with a
//!comment as required by the instructions. (link) - The module does not begin with a
//!comment as required by the instructions. (link)
General comments:
- Add a changelog entry to highlight that MAX_PUSH_RATE has become part of the public API.
- Update any example code or documentation in README or sample snippets to reference MAX_PUSH_RATE instead of hard-coded values.
- Consider whether DEFAULT_PUSH_RATE should also be exposed or documented, or clearly mark it as an internal implementation detail.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Add a changelog entry to highlight that MAX_PUSH_RATE has become part of the public API.
- Update any example code or documentation in README or sample snippets to reference MAX_PUSH_RATE instead of hard-coded values.
- Consider whether DEFAULT_PUSH_RATE should also be exposed or documented, or clearly mark it as an internal implementation detail.
## Individual Comments
### Comment 1
<location> `src/server/mod.rs:69` </location>
<code_context>
/// [`Unbound`] (not yet bound to a TCP listener) or [`Bound`]. New
-/// servers start `Unbound` and must call [`binding::WireframeServer::bind`] or
-/// [`binding::WireframeServer::bind_existing_listener`] before running. A worker task is spawned
+/// servers start `Unbound` and must call [`WireframeServer::bind`] or
+/// [`WireframeServer::bind_existing_listener`] before running. A worker task is spawned
/// per thread; each receives its own `WireframeApp` from the provided factory
</code_context>
<issue_to_address>
The module does not begin with a `//!` comment as required by the instructions.
Please add a `//!` module-level comment at the top of this file to describe its purpose and usage.
</issue_to_address>
### Comment 2
<location> `src/extractor.rs:21` </location>
<code_context>
///
/// This type contains metadata about the current connection and provides
-/// access to application state registered with [`WireframeApp`].
+/// access to application state registered with [`crate::app::WireframeApp`].
#[derive(Default)]
pub struct MessageRequest {
</code_context>
<issue_to_address>
The module does not begin with a `//!` comment as required by the instructions.
Please add a `//!` module-level comment at the top of this file to describe its purpose and usage.
</issue_to_address>
### Comment 3
<location> `src/hooks.rs:37` </location>
<code_context>
fn on_command_end(&self, _ctx: &mut ConnectionContext) {}
- /// Called when a handler returns a [`WireframeError::Protocol`].
+ /// Called when a handler returns a [`crate::WireframeError::Protocol`].
///
/// ```no_run
</code_context>
<issue_to_address>
The module does not begin with a `//!` comment as required by the instructions.
Please add a `//!` module-level comment at the top of this file to describe its purpose and usage.
</issue_to_address>
### Comment 4
<location> `src/push.rs:29` </location>
<code_context>
const DEFAULT_PUSH_RATE: usize = 100;
/// Highest supported rate for [`PushQueues::bounded_with_rate`].
-const MAX_PUSH_RATE: usize = 10_000;
+pub const MAX_PUSH_RATE: usize = 10_000;
/// Priority level for outbound messages.
</code_context>
<issue_to_address>
The module does not begin with a `//!` comment as required by the instructions.
Please add a `//!` module-level comment at the top of this file to describe its purpose and usage.
</issue_to_address>
### Comment 5
<location> `src/server/config/mod.rs:60` </location>
<code_context>
/// [`bind`](WireframeServer::bind) or
/// [`bind_existing_listener`](WireframeServer::bind_existing_listener)
- /// (methods provided by the [`binding`](self::binding) module) before running the server.
+ /// (methods provided by the [`binding`] module) before running the server.
///
/// # Examples
</code_context>
<issue_to_address>
The module does not begin with a `//!` comment as required by the instructions.
Please add a `//!` module-level comment at the top of this file to describe its purpose and usage.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| /// [`Unbound`] (not yet bound to a TCP listener) or [`Bound`]. New | ||
| /// servers start `Unbound` and must call [`binding::WireframeServer::bind`] or | ||
| /// [`binding::WireframeServer::bind_existing_listener`] before running. A worker task is spawned | ||
| /// servers start `Unbound` and must call [`WireframeServer::bind`] or |
There was a problem hiding this comment.
issue (review_instructions): The module does not begin with a //! comment as required by the instructions.
Please add a //! module-level comment at the top of this file to describe its purpose and usage.
Review instructions:
Path patterns: **/*.rs
Instructions:
Every module must begin with a //! comment.
| /// | ||
| /// This type contains metadata about the current connection and provides | ||
| /// access to application state registered with [`WireframeApp`]. | ||
| /// access to application state registered with [`crate::app::WireframeApp`]. |
There was a problem hiding this comment.
issue (review_instructions): The module does not begin with a //! comment as required by the instructions.
Please add a //! module-level comment at the top of this file to describe its purpose and usage.
Review instructions:
Path patterns: **/*.rs
Instructions:
Every module must begin with a //! comment.
| fn on_command_end(&self, _ctx: &mut ConnectionContext) {} | ||
|
|
||
| /// Called when a handler returns a [`WireframeError::Protocol`]. | ||
| /// Called when a handler returns a [`crate::WireframeError::Protocol`]. |
There was a problem hiding this comment.
issue (review_instructions): The module does not begin with a //! comment as required by the instructions.
Please add a //! module-level comment at the top of this file to describe its purpose and usage.
Review instructions:
Path patterns: **/*.rs
Instructions:
Every module must begin with a //! comment.
| const DEFAULT_PUSH_RATE: usize = 100; | ||
| /// Highest supported rate for [`PushQueues::bounded_with_rate`]. | ||
| const MAX_PUSH_RATE: usize = 10_000; | ||
| pub const MAX_PUSH_RATE: usize = 10_000; |
There was a problem hiding this comment.
issue (review_instructions): The module does not begin with a //! comment as required by the instructions.
Please add a //! module-level comment at the top of this file to describe its purpose and usage.
Review instructions:
Path patterns: **/*.rs
Instructions:
Every module must begin with a //! comment.
| /// [`bind`](WireframeServer::bind) or | ||
| /// [`bind_existing_listener`](WireframeServer::bind_existing_listener) | ||
| /// (methods provided by the [`binding`](self::binding) module) before running the server. | ||
| /// (methods provided by the [`binding`] module) before running the server. |
There was a problem hiding this comment.
issue (review_instructions): The module does not begin with a //! comment as required by the instructions.
Please add a //! module-level comment at the top of this file to describe its purpose and usage.
Review instructions:
Path patterns: **/*.rs
Instructions:
Every module must begin with a //! comment.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
1 participant
Summary
MAX_PUSH_RATEso docs reference a public constantWireframeError::ProtocolTesting
cargo doc --no-depsmake fmtmake lintmake testhttps://chatgpt.com/codex/tasks/task_e_689e54048724832288ec3a7fea3daa6e
Summary by Sourcery
Fix rustdoc link warnings by updating intra-doc links, exposing MAX_PUSH_RATE, and clarifying protocol hook documentation
New Features:
Enhancements: