Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Volatility -> Stability ratings

  • Loading branch information...
commit 572461661dd817c39fa1447d68878d2b35e94d80 1 parent 6624e84
@isaacs isaacs authored
Showing with 17 additions and 15 deletions.
  1. +17 −15 tools/doc/README.md
View
32 tools/doc/README.md
@@ -7,7 +7,7 @@ Each type of heading has a description block.
## module
- Volatility: 2 - Stable
+ Stability: 3 - Stable
description and examples.
@@ -77,25 +77,27 @@ Each type of heading has a description block.
* Methods have (list of arguments, description)
* Properties have (type, description)
-## Volatility ratings: 0-5
+## Stability ratings: 0-5
These can show up below any section heading, and apply to that section.
-0 - Locked. Unless serious bugs are found, this code will not ever
-change. Please do not bother to suggest changes in this area, they will
-be refused.
+0 - 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.
-1 - API Frozen. This API has been tested extensively in production and is
-unlikely to ever have to change.
+1 - Experimental. This feature was introduced recently, and may change
+or be removed in future versions. Please try it out and provide feedback.
+If it addresses a use-case that is important to you, tell the node core team.
-2 - Stable. The API has proven satisfactory, but cleanup in the underlying
-code may cause minor changes. Backwards-compatibility is guaranteed.
+2 - 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.
-3 - OK. The API has not had sufficient real-world testing to be considered
-stable. Backwards-compatibility will be maintained if reasonable.
+3 - Stable. The API has proven satisfactory, but cleanup in the underlying
+code may cause minor changes. Backwards-compatibility is guaranteed.
-4 - Experimental. This feature was introduced recently, and may change
-in future versions. Please try it out and provide feedback.
+4 - API Frozen. This API has been tested extensively in production and is
+unlikely to ever have to change.
-5 - Broken. This feature is known to be problematic, and changes are
-planned. Do not rely on it.
+5 - Locked. Unless serious bugs are found, this code will not ever
+change. Please do not suggest changes in this area, they will be refused.
Please sign in to comment.
Something went wrong with that request. Please try again.