Skip to content

Commit 57cda79

Browse files
committed
docs: copyediting of breaking-changes.md
Tweak the phrasing of sections' introductions
1 parent b0f1b5f commit 57cda79

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/api/breaking-changes.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Contract
22

3-
Breaking changes will be included in this documentation, and deprecation warnings added to JS code where possible, at least [one major version](electron-versioning.md#semver) before the change is made.
3+
Breaking changes will be documented here, and deprecation warnings added to JS code where possible, at least [one major version](electron-versioning.md#semver) before the change is made.
44

55
# `FIXME` comments
66

@@ -9,10 +9,7 @@ The `FIXME` string is used in code comments to denote things that should be fixe
99

1010
# Planned Breaking API Changes (4.0)
1111

12-
The following list includes the APIs that will be removed in Electron 4.0.
13-
14-
There is no timetable for when this release will occur but deprecation
15-
warnings will be added at least [one major version](electron-versioning.md#semver) beforehand.
12+
The following list includes the breaking API changes planned for Electron 4.0.
1613

1714
## `app.makeSingleInstance`
1815

@@ -40,7 +37,7 @@ app.releaseSingleInstanceLock()
4037

4138
# Planned Breaking API Changes (3.0)
4239

43-
The following list includes the APIs that will be removed in Electron 3.0.
40+
The following list includes the breaking API changes planned for Electron 3.0.
4441

4542
## `app`
4643

@@ -198,6 +195,8 @@ Replace with: https://atom.io/download/electron
198195

199196
# Breaking API Changes (2.0)
200197

198+
The following list includes the breaking API changes made in Electron 2.0.
199+
201200
## `BrowserWindow`
202201

203202
```js

0 commit comments

Comments
 (0)