Skip to content
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

fix: exclude from doctests example code that isn't meant to compile #2507

Merged
merged 1 commit into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions crates/rpc/src/jsonrpc/router/method.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ pub async fn handle_json_rpc_body(
}
}

/// ```
/// ```ignore
/// async fn example(RpcContext, impl DeserializeForVersion, RpcVersion) -> Result<Output, Into<RpcError>>
/// ```
impl<F, Input, Output, Error, Fut>
Expand Down Expand Up @@ -145,7 +145,7 @@ where
}
}

/// ```
/// ```ignore
/// async fn example(RpcContext, impl Deserialize) -> Result<Output, Into<RpcError>>
/// ```
impl<F, Input, Output, Error, Fut> IntoRpcEndpoint<((), Input), ((), Output), ((), RpcContext)>
Expand Down Expand Up @@ -194,7 +194,7 @@ where
}
}

/// ```
/// ```ignore
/// async fn example(impl Deserialize) -> Result<Output, Into<RpcError>>
/// ```
#[async_trait]
Expand Down Expand Up @@ -243,7 +243,7 @@ where
}
}

/// ```
/// ```ignore
/// async fn example(RpcContext) -> Result<Output, Into<RpcError>>
/// ```
#[async_trait]
Expand Down Expand Up @@ -294,7 +294,7 @@ where
}
}

/// ```
/// ```ignore
/// async fn example() -> Result<Output, Into<RpcError>>
/// ```
#[async_trait]
Expand Down Expand Up @@ -345,7 +345,7 @@ where
}
}

/// ```
/// ```ignore
/// fn example() -> &'static str
/// ```
#[async_trait]
Expand Down
4 changes: 2 additions & 2 deletions crates/rpc/src/jsonrpc/websocket.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//!
//!
//! Manual testing can be performed using `wscat`:
//! ```
//! ```ignore
//! > pierre:~/pathfinder$ wscat -c ws://localhost:9545/ws
//! Connected (press CTRL+C to quit)
//! > {"jsonrpc":"2.0", "id": 1, "method": "pathfinder_subscribe", "params": ["newHeads"]}
Expand All @@ -19,7 +19,7 @@
//!
//! Subscriptions may lag behind because of a slow network or slow client and
//! result in an error:
//! ```
//! ```ignore
//! > pierre:~/pathfinder$ wscat -c ws://localhost:9545/ws
//! Connected (press CTRL+C to quit)
//! > {"jsonrpc":"2.0", "id": 1, "method": "pathfinder_subscribe", "params":
Expand Down
Loading