From 7f64dbc1ba73fe1c323bb4ab41786666d41e2e7c Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Tue, 29 May 2018 11:15:30 +0200 Subject: [PATCH] Make FIXME and API Contract their own H1 sections Previously they were inside the 3.0 section, which doesn't really make sense --- docs/api/breaking-changes.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/api/breaking-changes.md b/docs/api/breaking-changes.md index 08fa88491a..2d158f3e34 100644 --- a/docs/api/breaking-changes.md +++ b/docs/api/breaking-changes.md @@ -1,10 +1,16 @@ +# 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. + +# `FIXME` comments + +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 (3.0) The following list includes the APIs that will be removed in Electron 3.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` ```js @@ -158,12 +164,6 @@ Deprecated: https://atom.io/download/atom-shell Replace with: https://atom.io/download/electron -## `FIXME` comments - -The `FIXME` string is used in code comments to denote things that should be -fixed for the 3.0 release. 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. @@ -192,4 +192,5 @@ app.on('second-instance', function (argv, cwd) { app.releaseSingleInstance() // Replace with app.releaseSingleInstanceLock() -``` \ No newline at end of file +``` +