Skip to content

Commit 12d3cdb

Browse files
Trottrvagg
authored andcommittedFeb 27, 2016
doc: remove out-of-date matter from internal docs
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]>
1 parent 4385367 commit 12d3cdb

File tree

1 file changed

+0
-25
lines changed

1 file changed

+0
-25
lines changed
 

‎tools/doc/README.md

-25
Original file line numberDiff line numberDiff line change
@@ -69,28 +69,3 @@ Each type of heading has a description block.
6969
* Events have (list of arguments, description)
7070
* Methods have (list of arguments, description)
7171
* Properties have (type, description)
72-
73-
## Stability ratings: 0-5
74-
75-
These can show up below any section heading, and apply to that section.
76-
77-
0 - Deprecated. This feature is known to be problematic, and changes are
78-
planned. Do not rely on it. Use of the feature may cause warnings. Backwards
79-
compatibility should not be expected.
80-
81-
1 - Experimental. This feature was introduced recently, and may change
82-
or be removed in future versions. Please try it out and provide feedback.
83-
If it addresses a use-case that is important to you, tell the node core team.
84-
85-
2 - Unstable. The API is in the process of settling, but has not yet had
86-
sufficient real-world testing to be considered stable. Backwards-compatibility
87-
will be maintained if reasonable.
88-
89-
3 - Stable. The API has proven satisfactory, but cleanup in the underlying
90-
code may cause minor changes. Backwards-compatibility is guaranteed.
91-
92-
4 - API Frozen. This API has been tested extensively in production and is
93-
unlikely to ever have to change.
94-
95-
5 - Locked. Unless serious bugs are found, this code will not ever
96-
change. Please do not suggest changes in this area, they will be refused.

0 commit comments

Comments
 (0)
Please sign in to comment.