Skip to content

Commit

Permalink
Fixes capabilities implementation package names in the comment
Browse files Browse the repository at this point in the history
  • Loading branch information
Michal Stopyra committed Feb 17, 2025
1 parent c0e5beb commit 2b243de
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ import sttp.capabilities.Streams
import sttp.tapir.WebSocketBodyOutput
import sttp.ws.WebSocket

/** Captures the logic of converting a [[WebSocket]] to a interpreter-specific pipe, which is then returned to the client. Implementations
/** Captures the logic of converting a [[WebSocket]] to an interpreter-specific pipe, which is then returned to the client. Implementations
* of this trait are looked up in the implicit scope by the compiler, depending on the capabilities that are required by the endpoint to be
* interpreted as a client.
*
* For capabilities `R`, where web sockets aren't included, the implementation just throws an unsupported exception (and this logic
* shouldn't ever be used). For capabilities which include web sockets, appropriate implementations should be imported, e.g. from the
* `sttp.tapir.client.sttp.ws.fs2._` or `sttp.tapir.client.sttp.ws.akka._` packages.
* `sttp.tapir.client.sttp4.ws.fs2._`, `sttp.tapir.client.sttp4.ws.pekkohttp._` or `sttp.tapir.client.sttp4.ws.zio._` packages.
*/
trait WebSocketToPipe[-R] {
type S <: Streams[S]
Expand Down

0 comments on commit 2b243de

Please sign in to comment.