Skip to content

Commit a935b63

Browse files
authored
Fix typos (#143)
1 parent ffe0055 commit a935b63

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

Sources/WebSocketKit/WebSocket+Connect.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ extension WebSocket {
4040
/// - configuration: Configuration for the WebSocket client.
4141
/// - eventLoopGroup: Event loop group to be used by the WebSocket client.
4242
/// - onUpgrade: An escaping closure to be executed after the upgrade is completed by `NIOWebSocketClientUpgrader`.
43-
/// - Returns: An future which completes when the connection to the WebSocket server is established.
43+
/// - Returns: A future which completes when the connection to the WebSocket server is established.
4444
@preconcurrency
4545
public static func connect(
4646
to url: URL,
@@ -75,7 +75,7 @@ extension WebSocket {
7575
/// - configuration: Configuration for the WebSocket client.
7676
/// - eventLoopGroup: Event loop group to be used by the WebSocket client.
7777
/// - onUpgrade: An escaping closure to be executed after the upgrade is completed by `NIOWebSocketClientUpgrader`.
78-
/// - Returns: An future which completes when the connection to the WebSocket server is established.
78+
/// - Returns: A future which completes when the connection to the WebSocket server is established.
7979
@preconcurrency
8080
public static func connect(
8181
scheme: String = "ws",
@@ -118,7 +118,7 @@ extension WebSocket {
118118
/// - configuration: Configuration for the WebSocket client.
119119
/// - eventLoopGroup: Event loop group to be used by the WebSocket client.
120120
/// - onUpgrade: An escaping closure to be executed after the upgrade is completed by `NIOWebSocketClientUpgrader`.
121-
/// - Returns: An future which completes when the connection to the origin server is established.
121+
/// - Returns: A future which completes when the connection to the origin server is established.
122122
@preconcurrency
123123
public static func connect(
124124
scheme: String = "ws",

Sources/WebSocketKit/WebSocketClient.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public final class WebSocketClient: Sendable {
9090
/// - proxyHeaders: Headers to send to the proxy server.
9191
/// - proxyConnectDeadline: Deadline for establishing the proxy connection.
9292
/// - onUpgrade: An escaping closure to be executed after the upgrade is completed by `NIOWebSocketClientUpgrader`.
93-
/// - Returns: An future which completes when the connection to the origin server is established.
93+
/// - Returns: A future which completes when the connection to the origin server is established.
9494
@preconcurrency
9595
public func connect(
9696
scheme: String,

Sources/WebSocketKit/WebSocketHandler.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ extension WebSocket {
3232
/// - Parameters:
3333
/// - channel: NIO channel which the client will use to communicate.
3434
/// - onUpgrade: An escaping closure to be executed the channel is configured with the WebSocket handlers.
35-
/// - Returns: An future which completes when the WebSocket connection to the server is established.
35+
/// - Returns: A future which completes when the WebSocket connection to the server is established.
3636
@preconcurrency
3737
public static func client(
3838
on channel: Channel,
@@ -46,7 +46,7 @@ extension WebSocket {
4646
/// - channel: NIO channel which the client/server will use to communicate.
4747
/// - config: Configuration for the client channel handlers.
4848
/// - onUpgrade: An escaping closure to be executed the channel is configured with the WebSocket handlers.
49-
/// - Returns: An future which completes when the WebSocket connection to the server is established.
49+
/// - Returns: A future which completes when the WebSocket connection to the server is established.
5050
@preconcurrency
5151
public static func client(
5252
on channel: Channel,
@@ -60,7 +60,7 @@ extension WebSocket {
6060
/// - Parameters:
6161
/// - channel: NIO channel which the server will use to communicate.
6262
/// - onUpgrade: An escaping closure to be executed the channel is configured with the WebSocket handlers.
63-
/// - Returns: An future which completes when the WebSocket connection to the server is established.
63+
/// - Returns: A future which completes when the WebSocket connection to the server is established.
6464
@preconcurrency
6565
public static func server(
6666
on channel: Channel,
@@ -74,7 +74,7 @@ extension WebSocket {
7474
/// - channel: NIO channel which the server will use to communicate.
7575
/// - config: Configuration for the server channel handlers.
7676
/// - onUpgrade: An escaping closure to be executed the channel is configured with the WebSocket handlers.
77-
/// - Returns: An future which completes when the WebSocket connection to the server is established.
77+
/// - Returns: A future which completes when the WebSocket connection to the server is established.
7878
@preconcurrency
7979
public static func server(
8080
on channel: Channel,

0 commit comments

Comments
 (0)