-
Notifications
You must be signed in to change notification settings - Fork 0
Fix rustdoc link warnings #316
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ pub trait WireframeProtocol: Send + Sync + 'static { | |
| /// Invoked when a request/response cycle completes. | ||
| 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`]. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. issue (review_instructions): The module does not begin with a Please add a Review instructions:Path patterns: Instructions: |
||
| /// | ||
| /// ```no_run | ||
| /// use wireframe::{ConnectionContext, WireframeProtocol}; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ impl<T> FrameLike for T where T: Send + 'static {} | |
| /// Default maximum pushes allowed per second when no custom rate is specified. | ||
| 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; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. issue (review_instructions): The module does not begin with a Please add a Review instructions:Path patterns: Instructions: |
||
|
|
||
| /// Priority level for outbound messages. | ||
| #[derive(Clone, Copy, Debug, PartialEq, Eq)] | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,7 +57,7 @@ where | |
| /// this cannot be determined). The server is initially [`Unbound`]; call | ||
| /// [`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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. issue (review_instructions): The module does not begin with a Please add a Review instructions:Path patterns: Instructions: |
||
| /// | ||
| /// # Examples | ||
| /// | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,8 +66,8 @@ pub type PreambleErrorHandler = Arc<dyn Fn(&DecodeError) + Send + Sync + 'static | |
| /// | ||
| /// The server carries a typestate `S` indicating whether it is | ||
| /// [`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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. issue (review_instructions): The module does not begin with a Please add a Review instructions:Path patterns: Instructions: |
||
| /// [`WireframeServer::bind_existing_listener`] before running. A worker task is spawned | ||
| /// per thread; each receives its own `WireframeApp` from the provided factory | ||
| /// closure. The server listens for a shutdown signal using | ||
| /// `tokio::signal::ctrl_c` and notifies all workers to stop accepting new | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
**/*.rsInstructions:
Every module must begin with a
//!comment.