Browse Source

docs: copyediting of breaking-changes.md

Tweak the phrasing of sections' introductions
Charles Kerr 6 years ago
parent
commit
57cda797f3
1 changed files with 5 additions and 6 deletions
  1. 5 6
      docs/api/breaking-changes.md

+ 5 - 6
docs/api/breaking-changes.md

@@ -1,6 +1,6 @@
 # API Contract
 
-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.
+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.
 
 # `FIXME` comments
 
@@ -9,10 +9,7 @@ The `FIXME` string is used in code comments to denote things that should be fixe
 
 # Planned Breaking API Changes (4.0)
 
-The following list includes the APIs that will be removed in Electron 4.0.
-
-There is no timetable for when this release will occur but deprecation
-warnings will be added at least [one major version](electron-versioning.md#semver) beforehand.
+The following list includes the breaking API changes planned for Electron 4.0.
 
 ## `app.makeSingleInstance`
 
@@ -40,7 +37,7 @@ app.releaseSingleInstanceLock()
 
 # Planned Breaking API Changes (3.0)
 
-The following list includes the APIs that will be removed in Electron 3.0.
+The following list includes the breaking API changes planned for Electron 3.0.
 
 ## `app`
 
@@ -198,6 +195,8 @@ Replace with: https://atom.io/download/electron
 
 # Breaking API Changes (2.0)
 
+The following list includes the breaking API changes made in Electron 2.0.
+
 ## `BrowserWindow`
 
 ```js