Add hint for on further details for WebSocket (#1779)

tokio-rs · Feb 22, 2023 · fa36b49 · fa36b49
1 parent 1e2567c
commit fa36b49
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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>,