Documentation stability levels: Difference between revisions
(Created page with "== Deprecated == This feature is known to be problematic, and changes are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should ...") |
(→Frozen) |
||
Line 32: | Line 32: | ||
In creating this we were inspired by the | In creating this we were inspired by the [http://nodejs.org/api/documentation.html#documentation_stability_index node.js stability index]. Thanks a lot, you rock. |
Revision as of 13:59, 25 April 2013
Deprecated
This feature is known to be problematic, and changes are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should not be expected.
Changes will not be announced.
Experimental
This feature was introduced recently, and may change or be removed in future versions. Please try it out and provide feedback.
Changes will not be announced.
Unstable
The API is in the process of settling, but has not yet had sufficient real-world testing to be considered stable. Backwards-compatibility will be maintained if reasonable.
Changes will not be announced. We recommend using the watch function for the given page to keep updated.
Stable
The API has proven satisfactory, but cleanup in the underlying code may cause minor changes. Backwards-compatibility is attempted really hard.
Changes will be announced in the release notes.
Frozen
This API has been tested extensively in production and is unlikely to ever have to change. Backwards-compatibility is guaranteed.
Changes will be announced in the release notes, parallel versions will be maintained for two major releases.
In creating this we were inspired by the node.js stability index. Thanks a lot, you rock.