Skip to content

Remove documentation about WebSocketChannel.new in doc comment #1823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brianquinlan merged 5 commits into from
Sep 23, 2025
Merged

Remove documentation about WebSocketChannel.new in doc comment #1823

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7fe45d4
Update WebSocketChannel documentation
benjaminpjones Sep 20, 2025
25c9242
Update CHANGELOG.md
benjaminpjones Sep 20, 2025
8380be0
Update version in pubspec.yaml
benjaminpjones Sep 20, 2025
6cac956
Add wip tag to version
benjaminpjones Sep 23, 2025
5800c50
Add wip tag to version in CHANGELOG.md
benjaminpjones Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pkgs/web_socket_channel/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 3.0.4

- Remove obsolete documentation for `WebSocketChannel.new`.

## 3.0.3

- Support `package:web_socket` 1.0.0.
Expand Down
2 changes: 0 additions & 2 deletions pkgs/web_socket_channel/lib/src/channel.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ const String _webSocketGUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
/// A [StreamChannel] that communicates over a WebSocket.
///
/// This is implemented by classes that use `dart:io` and `dart:html`.
/// The [WebSocketChannel.new] constructor can also be used on any platform to
/// connect to use the WebSocket protocol over a pre-existing channel.
///
/// All implementations emit [WebSocketChannelException]s. These exceptions wrap
/// the native exception types where possible.
Expand Down
2 changes: 1 addition & 1 deletion pkgs/web_socket_channel/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: web_socket_channel
version: 3.0.3
version: 3.0.4
description: >-
A WebSocket API that enables cross-platform communication via StreamChannel.
repository: https://github.com/dart-lang/http/tree/master/pkgs/web_socket_channel
Expand Down
Loading