From 8fd033158ed86cc0e57738d3f5a8478abf5bca7f Mon Sep 17 00:00:00 2001 From: adamw Date: Fri, 3 Jan 2025 11:54:31 +0100 Subject: [PATCH] fix docs --- docs/backends/synchronous.md | 2 +- docs/other/websockets.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/backends/synchronous.md b/docs/backends/synchronous.md index 723905bcc..ef72baa3b 100644 --- a/docs/backends/synchronous.md +++ b/docs/backends/synchronous.md @@ -102,7 +102,7 @@ Both HttpClient and OkHttp backends support regular [websockets](../other/websoc "com.softwaremill.sttp.client4" %% "ox" % "@VERSION@", ``` -```scala mdoc:compile-only +```scala import sttp.client4.* import sttp.client4.impl.ox.sse.OxServerSentEvents import java.io.InputStream diff --git a/docs/other/websockets.md b/docs/other/websockets.md index adf43f5d5..a821467b6 100644 --- a/docs/other/websockets.md +++ b/docs/other/websockets.md @@ -73,7 +73,7 @@ def asWebSocketStream[S](s: Streams[S])(p: s.Pipe[WebSocketFrame.Data[_], WebSoc WebSocketStreamResponseAs[Either[String, Unit], S] = ??? def asWebSocketStreamOrFail[S](s: Streams[S])(p: s.Pipe[WebSocketFrame.Data[_], WebSocketFrame]): - WebSocketStreamResponseAs[Unit, S] = + WebSocketStreamResponseAs[Unit, S] = ??? ``` Using streaming websockets requires the backend to support the given streaming capability (see also [streaming](../requests/streaming.md)). Streaming capabilities are described as implementations of `Streams[S]`, and are provided by backend implementations, e.g. `PekkoStreams` or `Fs2Streams[F]`.