From fe25b9dfdb6d0c73ec4ef060974a619b83d1e22f Mon Sep 17 00:00:00 2001 From: Simon Lydell Date: Mon, 12 Dec 2016 07:44:59 +0100 Subject: [PATCH] Remove mentions of 1.0.0 in the documentation --- documentation/CONTRIBUTING-CODE.md | 10 +++++----- documentation/api.md | 10 ---------- 2 files changed, 5 insertions(+), 15 deletions(-) diff --git a/documentation/CONTRIBUTING-CODE.md b/documentation/CONTRIBUTING-CODE.md index 67dfb5a..2e7a1ae 100644 --- a/documentation/CONTRIBUTING-CODE.md +++ b/documentation/CONTRIBUTING-CODE.md @@ -71,11 +71,11 @@ Finally send a pull request to same branch as you based your topic branch on VimFx uses three numbers to describe its version: x.y.z, or major.minor.patch. -Version 1.0.0 will soon be released. When that’s the case, the first number -(major) will only be incremented when there are backwards-incompatible changes, -such as changes to defaults or to the [config file API]. This should be avoided. -The idea is that when a user installs a new major release, they should expect -changes that they need to get familiar with. +When version 1.0.0 has been released, the first number (major) will only be +incremented when there are backwards-incompatible changes, such as changes to +defaults or to the [config file API]. This should be avoided. The idea is that +when a user installs a new major release, they should expect changes that they +need to get familiar with. The middle number (minor) is incremented when a release contains new features, or larger changes/refactors to code. Users should expect things to be roughly diff --git a/documentation/api.md b/documentation/api.md index 5bd9fac..386aded 100644 --- a/documentation/api.md +++ b/documentation/api.md @@ -898,16 +898,6 @@ returns the DOM element associated with that id. If no element can be found, `null` is returned. -## Stability - -The API is currently **experimental** and therefore **unstable.** Things might -break with new VimFx versions. However, no breaking changes are planned, and -will be avoided if feasible. - -As soon as VimFx 1.0.0 (which does not seem to be too far away) is released -backwards compatibility will be a priority and won’t be broken until VimFx -2.0.0. - [option overrides]: #vimfxaddoptionoverridesrules [`vimfx.send(...)`]: #vimfxsendvim-message-data--null-callback--null [`vimfx.listen(...)`]: #vimfxlistenmessage-listener -- 2.39.3