From 57ad506cde45c2ca0591c0b3371d80599c5d8cf1 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Tue, 29 May 2018 11:17:26 +0200 Subject: [PATCH] Reorder the version sections newest-to-oldest This puts 4.0 before 3.0, making room to re-add the 2.0 changes back in at the end of the file. --- docs/api/breaking-changes.md | 61 ++++++++++++++++++------------------ 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/docs/api/breaking-changes.md b/docs/api/breaking-changes.md index 2d158f3e34f2..1646b4ab1c98 100644 --- a/docs/api/breaking-changes.md +++ b/docs/api/breaking-changes.md @@ -7,6 +7,37 @@ Breaking changes will be included in this documentation, and deprecation warning The `FIXME` string is used in code comments to denote things that should be fixed for future releases. See https://github.com/electron/electron/search?q=fixme +# 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. + +## `app.makeSingleInstance` + +```js +// Deprecated +app.makeSingleInstance(function (argv, cwd) { + +}) +// Replace with +app.requestSingleInstanceLock() +app.on('second-instance', function (argv, cwd) { + +}) +``` + +## `app.releaseSingleInstance` + +```js +// Deprecated +app.releaseSingleInstance() +// Replace with +app.releaseSingleInstanceLock() +``` + + # Planned Breaking API Changes (3.0) The following list includes the APIs that will be removed in Electron 3.0. @@ -164,33 +195,3 @@ Deprecated: https://atom.io/download/atom-shell Replace with: https://atom.io/download/electron -# 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. - -## `app.makeSingleInstance` - -```js -// Deprecated -app.makeSingleInstance(function (argv, cwd) { - -}) -// Replace with -app.requestSingleInstanceLock() -app.on('second-instance', function (argv, cwd) { - -}) -``` - -## `app.releaseSingleInstance` - -```js -// Deprecated -app.releaseSingleInstance() -// Replace with -app.releaseSingleInstanceLock() -``` -