Skip to content

Commit

Permalink
Add release note for mdn#12300
Browse files Browse the repository at this point in the history
  • Loading branch information
ddbeck committed Sep 23, 2021
1 parent 9c63fb5 commit 1b2ae13
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,24 @@

### Notable changes

- The feature-naming convention `returns_promise` has been adopted for features that capture some but not all browsers' APIs returning a `Promise`. The [new data guideline](https://github.com/mdn/browser-compat-data/blob/main/docs/data-guidelines.md#methods-returning-promises-returns_promise) is meant to bring consistency to a few different styles used throughout the API data. The following features have been renamed to `returns_promise` ([#11630](https://github.com/mdn/browser-compat-data/pull/11630)):
- The feature-naming convention `returns_promise` has been adopted for features that capture some but not all browsers' APIs returning a `Promise`. The [new data guideline](https://github.com/mdn/browser-compat-data/blob/main/docs/data-guidelines.md#methods-returning-promises-returns_promise) brings consistency to a competing styles used throughout the API data.

The following features have been renamed to `returns_promise` ([#11630](https://github.com/mdn/browser-compat-data/pull/11630)):

- `api.BaseAudioContext.decodeAudioData.promise_syntax`
- `api.Document.exitFullscreen.returns_a_promise`
- `api.Element.requestFullscreen.returns_a_promise`
- `api.OfflineAudioContext.startRendering.Promise_based_startRendering`

The feature `api.RTCPeerConnection.getStats.with_callbacks` was removed and the data for several `RTCPeerConnection` methods expanded with `returns_promise` data. The following features have been added ([#12300](https://github.com/mdn/browser-compat-data/pull/12300)):

- `api.RTCPeerConnection.addIceCandidate.returns_promise`
- `api.RTCPeerConnection.createAnswer.returns_promise`
- `api.RTCPeerConnection.createOffer.returns_promise`
- `api.RTCPeerConnection.getStats.returns_promise`
- `api.RTCPeerConnection.setLocalDescription.returns_promise`
- `api.RTCPeerConnection.setRemoteDescription.returns_promise`

- The following non-existent, long-removed, or otherwise irrelevant features have been removed:

- `api.CryptoKeyPair` ([#12346](https://github.com/mdn/browser-compat-data/pull/12346))
Expand Down

0 comments on commit 1b2ae13

Please sign in to comment.