Skip to content

Commit 708e919

Browse files
committed
Consistently format breaking changes
Moved the bug-id to the breaking change prefix. This also makes it easy to validate that an approved breaking change issue exists. Closes #37409 #37409 GitOrigin-RevId: c670478 Change-Id: I587fc70d5edbcbd80703cf78b4540b550c33eb35 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/107820 Reviewed-by: Aadil Maan <[email protected]>
1 parent a4f34f4 commit 708e919

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

CHANGELOG.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
### Core libraries
88

9-
* **Breaking change:** As part of (Issue [36900][]), the following methods and
9+
* **Breaking change** [#36900](https://github.com/dart-lang/sdk/issues/36900):
10+
The following methods and
1011
properties across various core libraries, which used to declare a return type
1112
of `List<int>`, were updated to declare a return type of `Uint8List`:
1213

@@ -46,8 +47,7 @@
4647
* `Uint32List.sublist()``Uint32List`
4748
* `Uint64List.sublist()``Uint64List`
4849

49-
[36900]: https://github.com/dart-lang/sdk/issues/36900
50-
50+
5151
#### `dart:core`
5252

5353
* Update `Uri` class to support [RFC6874](https://tools.ietf.org/html/rfc6874):
@@ -60,8 +60,9 @@
6060

6161
#### `dart:io`
6262

63-
* **Breaking Change:** The `Cookie` class's constructor's `name` and `value`
64-
optional positional parameters are now mandatory (Issue [37192][]). The
63+
* **Breaking change** [#37192](https://github.com/dart-lang/sdk/issues/37192):
64+
The `Cookie` class's constructor's `name` and `value`
65+
optional positional parameters are now mandatory. The
6566
signature changes from:
6667

6768
Cookie([String name, String value])
@@ -77,13 +78,12 @@
7778
Since code could not previously correctly omit the parameters, this is not
7879
really a breaking change.
7980

80-
* **Breaking Change:** The `Cookie` class's `name` and `value` setters now
81+
* **Breaking change** [#37192](https://github.com/dart-lang/sdk/issues/37192):
82+
The `Cookie` class's `name` and `value` setters now
8183
validates that the strings are made from the allowed character set and are not
82-
null (Issue [37192][]). The constructor already made these checks and this
84+
null. The constructor already made these checks and this
8385
fixes the loophole where the setters didn't also validate.
8486

85-
[37192]: https://github.com/dart-lang/sdk/issues/37192
86-
8787
### Dart VM
8888

8989
### Tools
@@ -131,28 +131,29 @@ communication of `Uint8List` data.
131131
[33327]: https://github.com/dart-lang/sdk/issues/33327
132132
[35804]: https://github.com/dart-lang/sdk/issues/35804
133133

134-
* The `HttpClientResponse` interface has been extended with the addition of a
134+
* **Breaking change** [#36971](https://github.com/dart-lang/sdk/issues/36971):
135+
The `HttpClientResponse` interface has been extended with the addition of a
135136
new `compressionState` getter, which specifies whether the body of a
136137
response was compressed when it was received and whether it has been
137-
automatically uncompressed via `HttpClient.autoUncompress` (Issue [36971][]).
138+
automatically uncompressed via `HttpClient.autoUncompress`.
138139

139140
As part of this change, a corresponding new enum was added to `dart:io`:
140141
`HttpClientResponseCompressionState`.
141142

142-
[36971]: https://github.com/dart-lang/sdk/issues/36971
143-
144-
* **Breaking change**: For those implementing the `HttpClientResponse`
145-
interface, this is a breaking change, as implementing classes will need to
146-
implement the new getter.
143+
For those implementing the `HttpClientResponse`
144+
interface, this is a breaking change, as implementing classes will need to
145+
implement the new getter.
147146

148147
#### `dart:async`
149148

150-
* **Breaking change:** The `await for` allowed `null` as a stream due to a bug
149+
* **Breaking change** [#36382](https://github.com/dart-lang/sdk/issues/36382):
150+
The `await for` allowed `null` as a stream due to a bug
151151
in `StreamIterator` class. This bug has now been fixed.
152152

153153
#### `dart:core`
154154

155-
* **Breaking change:** The `RegExp` interface has been extended with two new
155+
* **Breaking change** [#36171](https://github.com/dart-lang/sdk/issues/36171):
156+
The `RegExp` interface has been extended with two new
156157
constructor named parameters:
157158

158159
* `unicode:` (`bool`, default: `false`), for Unicode patterns
@@ -175,8 +176,9 @@ communication of `Uint8List` data.
175176

176177
### Language
177178

178-
* **Breaking change:** Covariance of type variables used in super-interfaces
179-
is now enforced (issue [35097][]). For example, the following code was
179+
* **Breaking change** [#35097](https://github.com/dart-lang/sdk/issues/35097):
180+
Covariance of type variables used in super-interfaces
181+
is now enforced. For example, the following code was
180182
previously accepted and will now be rejected:
181183

182184
```dart
@@ -187,8 +189,6 @@ class B<X> extends A<void Function(X)> {};
187189
* The identifier `async` can now be used in asynchronous and generator
188190
functions.
189191

190-
[35097]: https://github.com/dart-lang/sdk/issues/35097
191-
192192
### Dart for the Web
193193

194194
#### Dart Dev Compiler (DDC)

0 commit comments

Comments
 (0)