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
https://github.com/dart-lang/sdk/pull/37409

GitOrigin-RevId: c6704788731658e2f23e611456f22a9f0762e75d
Change-Id: I587fc70d5edbcbd80703cf78b4540b550c33eb35
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/107820
Reviewed-by: Aadil Maan <aadilmaan@google.com>
This commit is contained in:
Michael Thomsen 2019-07-04 12:07:42 +00:00 committed by Michael Thomsen
parent a4f34f4a51
commit 708e919733

View file

@ -6,7 +6,8 @@
### Core libraries ### Core libraries
* **Breaking change:** As part of (Issue [36900][]), the following methods and * **Breaking change** [#36900](https://github.com/dart-lang/sdk/issues/36900):
The following methods and
properties across various core libraries, which used to declare a return type properties across various core libraries, which used to declare a return type
of `List<int>`, were updated to declare a return type of `Uint8List`: of `List<int>`, were updated to declare a return type of `Uint8List`:
@ -46,7 +47,6 @@
* `Uint32List.sublist()``Uint32List` * `Uint32List.sublist()``Uint32List`
* `Uint64List.sublist()``Uint64List` * `Uint64List.sublist()``Uint64List`
[36900]: https://github.com/dart-lang/sdk/issues/36900
#### `dart:core` #### `dart:core`
@ -60,8 +60,9 @@
#### `dart:io` #### `dart:io`
* **Breaking Change:** The `Cookie` class's constructor's `name` and `value` * **Breaking change** [#37192](https://github.com/dart-lang/sdk/issues/37192):
optional positional parameters are now mandatory (Issue [37192][]). The The `Cookie` class's constructor's `name` and `value`
optional positional parameters are now mandatory. The
signature changes from: signature changes from:
Cookie([String name, String value]) Cookie([String name, String value])
@ -77,13 +78,12 @@
Since code could not previously correctly omit the parameters, this is not Since code could not previously correctly omit the parameters, this is not
really a breaking change. really a breaking change.
* **Breaking Change:** The `Cookie` class's `name` and `value` setters now * **Breaking change** [#37192](https://github.com/dart-lang/sdk/issues/37192):
The `Cookie` class's `name` and `value` setters now
validates that the strings are made from the allowed character set and are not validates that the strings are made from the allowed character set and are not
null (Issue [37192][]). The constructor already made these checks and this null. The constructor already made these checks and this
fixes the loophole where the setters didn't also validate. fixes the loophole where the setters didn't also validate.
[37192]: https://github.com/dart-lang/sdk/issues/37192
### Dart VM ### Dart VM
### Tools ### Tools
@ -131,28 +131,29 @@ communication of `Uint8List` data.
[33327]: https://github.com/dart-lang/sdk/issues/33327 [33327]: https://github.com/dart-lang/sdk/issues/33327
[35804]: https://github.com/dart-lang/sdk/issues/35804 [35804]: https://github.com/dart-lang/sdk/issues/35804
* The `HttpClientResponse` interface has been extended with the addition of a * **Breaking change** [#36971](https://github.com/dart-lang/sdk/issues/36971):
The `HttpClientResponse` interface has been extended with the addition of a
new `compressionState` getter, which specifies whether the body of a new `compressionState` getter, which specifies whether the body of a
response was compressed when it was received and whether it has been response was compressed when it was received and whether it has been
automatically uncompressed via `HttpClient.autoUncompress` (Issue [36971][]). automatically uncompressed via `HttpClient.autoUncompress`.
As part of this change, a corresponding new enum was added to `dart:io`: As part of this change, a corresponding new enum was added to `dart:io`:
`HttpClientResponseCompressionState`. `HttpClientResponseCompressionState`.
[36971]: https://github.com/dart-lang/sdk/issues/36971 For those implementing the `HttpClientResponse`
* **Breaking change**: For those implementing the `HttpClientResponse`
interface, this is a breaking change, as implementing classes will need to interface, this is a breaking change, as implementing classes will need to
implement the new getter. implement the new getter.
#### `dart:async` #### `dart:async`
* **Breaking change:** The `await for` allowed `null` as a stream due to a bug * **Breaking change** [#36382](https://github.com/dart-lang/sdk/issues/36382):
The `await for` allowed `null` as a stream due to a bug
in `StreamIterator` class. This bug has now been fixed. in `StreamIterator` class. This bug has now been fixed.
#### `dart:core` #### `dart:core`
* **Breaking change:** The `RegExp` interface has been extended with two new * **Breaking change** [#36171](https://github.com/dart-lang/sdk/issues/36171):
The `RegExp` interface has been extended with two new
constructor named parameters: constructor named parameters:
* `unicode:` (`bool`, default: `false`), for Unicode patterns * `unicode:` (`bool`, default: `false`), for Unicode patterns
@ -175,8 +176,9 @@ communication of `Uint8List` data.
### Language ### Language
* **Breaking change:** Covariance of type variables used in super-interfaces * **Breaking change** [#35097](https://github.com/dart-lang/sdk/issues/35097):
is now enforced (issue [35097][]). For example, the following code was Covariance of type variables used in super-interfaces
is now enforced. For example, the following code was
previously accepted and will now be rejected: previously accepted and will now be rejected:
```dart ```dart
@ -187,8 +189,6 @@ class B<X> extends A<void Function(X)> {};
* The identifier `async` can now be used in asynchronous and generator * The identifier `async` can now be used in asynchronous and generator
functions. functions.
[35097]: https://github.com/dart-lang/sdk/issues/35097
### Dart for the Web ### Dart for the Web
#### Dart Dev Compiler (DDC) #### Dart Dev Compiler (DDC)