From 9f4e35c270d1ae063c370579df4e86ed0fcbd0bf Mon Sep 17 00:00:00 2001 From: Fabian Bernhart <135550293+fabianbernhart@users.noreply.github.com> Date: Thu, 30 Oct 2025 14:07:19 +0100 Subject: [PATCH 1/2] docs: update `Splitting Connection` notes --- src/lib.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index fc2105c..8a4f351 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -284,10 +284,10 @@ //! In some cases, you might want to split the WebSocket connection into a read half and a write half. //! This can be achieved using the [`WebSocket::split_with`] method, which returns a [`WebSocketRead`] and [`WebSocketWrite`] tuple. //! -//! ### Note -//! +//!
//! Due to the `lazy` nature of the library, splitting the connection will sacrifice the automatic handling of `Ping` and `Close` messages. -//! ``` +//!
+//! //! # async fn split() { //! # use websocketz::mock::Noop; //! # use websocketz::{Message, WebSocket, next, options::ConnectOptions}; From 7b6b4e5bf9dada32acd75af241e5b541f3ff95e7 Mon Sep 17 00:00:00 2001 From: fab Date: Thu, 30 Oct 2025 14:39:54 +0100 Subject: [PATCH 2/2] docs: fix docs code --- src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/lib.rs b/src/lib.rs index 8a4f351..3f71fbf 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -288,6 +288,7 @@ //! Due to the `lazy` nature of the library, splitting the connection will sacrifice the automatic handling of `Ping` and `Close` messages. //! //! +//! ``` //! # async fn split() { //! # use websocketz::mock::Noop; //! # use websocketz::{Message, WebSocket, next, options::ConnectOptions};