From 34cfc28a46f9c8cadc1f9fcd7cdbe8e620aa961e Mon Sep 17 00:00:00 2001 From: Brian Quinlan Date: Fri, 17 May 2024 13:07:54 -0700 Subject: [PATCH 1/2] Remove obsolete `WebSocketChannel.new` documentation. --- CHANGELOG.md | 1 + README.md | 16 ---------------- 2 files changed, 1 insertion(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d1b3d18..0344397 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ ## 3.0.1-wip - Remove unnecessary `dependency_overrides`. +- Remove obsolete documentation for `WebSocketChannel.new`. ## 3.0.0 diff --git a/README.md b/README.md index 35f16c8..a4985fb 100644 --- a/README.md +++ b/README.md @@ -64,19 +64,3 @@ other socket exactly why they're closing the connection. [sink]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel/sink.html [WebSocketSink]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketSink-class.html [sink.close]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketSink/close.html - -`WebSocketChannel` also works as a cross-platform implementation of the -WebSocket protocol. The [`WebSocketChannel.connect` constructor][connect] -connects to a listening server using the appropriate implementation for the -platform. The [`WebSocketChannel()` constructor][new] takes an underlying -[`StreamChannel`][stream_channel] over which it communicates using the WebSocket -protocol. It also provides the static [`signKey()`][signKey] method to make it -easier to implement the [initial WebSocket handshake][]. These are used in the -[`shelf_web_socket`][shelf_web_socket] package to support WebSockets in a -cross-platform way. - -[connect]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel/WebSocketChannel.connect.html -[new]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel/WebSocketChannel.html -[signKey]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel/signKey.html -[initial WebSocket handshake]: https://tools.ietf.org/html/rfc6455#section-4.2.2 -[shelf_web_socket]: https://pub.dev/packages/shelf_web_socket From 03976934658f9271fa0037be1db081ad869256db Mon Sep 17 00:00:00 2001 From: Brian Quinlan Date: Fri, 17 May 2024 13:22:15 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index a4985fb..3ff0637 100644 --- a/README.md +++ b/README.md @@ -64,3 +64,10 @@ other socket exactly why they're closing the connection. [sink]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel/sink.html [WebSocketSink]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketSink-class.html [sink.close]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketSink/close.html + +`WebSocketChannel` also works as a cross-platform implementation of the +WebSocket protocol. The [`WebSocketChannel.connect` constructor][connect] +connects to a listening server using the appropriate implementation for the +platform. + +[connect]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel/WebSocketChannel.connect.html \ No newline at end of file