Skip to content

Commit 04a3f9e

Browse files
committed
2.4 changelog: be more clear and consistent on breaking changes
Use the same language when describing a change that is only breaking for implementors of a type Change-Id: Ice9472f0582c3b737034a63fb8a3bc3adc5ae96e Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/108683 Reviewed-by: Vijay Menon <[email protected]> Auto-Submit: Kevin Moore <[email protected]>
1 parent ccdddd2 commit 04a3f9e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

CHANGELOG.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ communication of `Uint8List` data.
161161
[33327]: https://github.com/dart-lang/sdk/issues/33327
162162
[35804]: https://github.com/dart-lang/sdk/issues/35804
163163

164-
* **Breaking change** [#36971](https://github.com/dart-lang/sdk/issues/36971):
164+
* [#36971](https://github.com/dart-lang/sdk/issues/36971):
165165
The `HttpClientResponse` interface has been extended with the addition of a
166166
new `compressionState` getter, which specifies whether the body of a
167167
response was compressed when it was received and whether it has been
@@ -170,19 +170,18 @@ communication of `Uint8List` data.
170170
As part of this change, a corresponding new enum was added to `dart:io`:
171171
`HttpClientResponseCompressionState`.
172172

173-
For those implementing the `HttpClientResponse`
174-
interface, this is a breaking change, as implementing classes will need to
175-
implement the new getter.
173+
This is a **breaking change** for those implementing the `HttpClientResponse`
174+
interface as subclasses will need to implement the new getter.
176175

177176
#### `dart:async`
178177

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

183182
#### `dart:core`
184183

185-
* **Breaking change** [#36171](https://github.com/dart-lang/sdk/issues/36171):
184+
* [#36171](https://github.com/dart-lang/sdk/issues/36171):
186185
The `RegExp` interface has been extended with two new
187186
constructor named parameters:
188187

@@ -201,8 +200,9 @@ communication of `Uint8List` data.
201200
* `String namedGroup(String name)`, a method that retrieves the match for
202201
the given named capture group
203202

204-
This change only affects implementers of the `RegExp` interface; current
205-
code using Dart regular expressions will not be affected.
203+
This is a **breaking change** for implementers of the `RegExp` interface.
204+
Subclasses will need to add the new properties and may have to update the
205+
return types on overridden methods.
206206

207207
### Language
208208

0 commit comments

Comments
 (0)