Skip to content

Commit

Permalink
doc: remove out-of-date matter from internal docs
Browse files Browse the repository at this point in the history
Remove out-of-date stability index material from `tools/doc/README.md`.
The stability index is documented in `doc/api/documentation.markdown`.

PR-URL: #5421
Reviewed-By: Evan Lucas <[email protected]>
  • Loading branch information
Trott authored and Myles Borins committed Mar 1, 2016
1 parent 394743f commit a2613ae
Showing 1 changed file with 0 additions and 25 deletions.
25 changes: 0 additions & 25 deletions tools/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,28 +69,3 @@ Each type of heading has a description block.
* Events have (list of arguments, description)
* Methods have (list of arguments, description)
* Properties have (type, description)

## Stability ratings: 0-5

These can show up below any section heading, and apply to that section.

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 - 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 - 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 - Stable. The API has proven satisfactory, but cleanup in the underlying
code may cause minor changes. Backwards-compatibility is guaranteed.

4 - API Frozen. This API has been tested extensively in production and is
unlikely to ever have to change.

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.

0 comments on commit a2613ae

Please sign in to comment.