From fa36b497690f67f486050fac4f3d2b7f24d13e72 Mon Sep 17 00:00:00 2001
From: Hugo <hugo@whynothugo.nl>
Date: Wed, 22 Feb 2023 13:25:37 +0100
Subject: [PATCH] Add hint for on further details for WebSocket (#1779)

---
 axum/src/extract/ws.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/axum/src/extract/ws.rs b/axum/src/extract/ws.rs
index 8c5e6f9a1f..43ef0db0dc 100644
--- a/axum/src/extract/ws.rs
+++ b/axum/src/extract/ws.rs
@@ -438,6 +438,8 @@ fn header_contains(headers: &HeaderMap, key: HeaderName, value: &'static str) ->
 }
 
 /// A stream of WebSocket messages.
+///
+/// See [the module level documentation](self) for more details.
 #[derive(Debug)]
 pub struct WebSocket {
     inner: WebSocketStream<Upgraded>,