Skip to content

Commit e218f6f

Browse files
fabianbernhartfab
andauthored
docs: update Splitting Connection notes
* docs: update `Splitting Connection` notes * docs: fix docs code --------- Co-authored-by: fab <fabian.bernhart@gselectronic.com>
1 parent 1b2f73c commit e218f6f

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,9 +284,10 @@
284284
//! In some cases, you might want to split the WebSocket connection into a read half and a write half.
285285
//! This can be achieved using the [`WebSocket::split_with`] method, which returns a [`WebSocketRead`] and [`WebSocketWrite`] tuple.
286286
//!
287-
//! ### Note
288-
//!
287+
//! <div class="warning">
289288
//! Due to the `lazy` nature of the library, splitting the connection will sacrifice the automatic handling of `Ping` and `Close` messages.
289+
//! </div>
290+
//!
290291
//! ```
291292
//! # async fn split() {
292293
//! # use websocketz::mock::Noop;

0 commit comments

Comments
 (0)