RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: use Go convention for deprectated APIs 

Signed-off-by: Sven Anderson <sven@redhat.com>
This commit is contained in:
Sven Anderson 2021-10-01 17:16:29 +09:00 committed by mergify[bot]
parent 97630486ee
commit ac4494e707
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api-stability.md
View File

@ -17,12 +17,13 @@ convention in the Go community.
## Deprecated
This is a level for APIs that should not be used for new code. These are marked
with _DEPRECATED_ in the documentation. During 0.x releases these APIs might get
removed in a future release, especially the 1.0 release, so we recommend
refactoring the code at the earliest convenience. After the 1.0 release,
deprecated APIs will not be removed, however they are still deprecated and only
in maintanence mode. We usually don't make improvements for these APIs and we
can't guarantee optimal performance.
as deprecated according to Go conventions in the documentation (that is, a
paragraph beginning with _Deprecated:_). During 0.x releases these APIs
might get removed in a future release, especially the 1.0 release, so we
recommend refactoring the code at the earliest convenience. After the 1.0
release, deprecated APIs will not be removed, however they are still deprecated
and only in maintanence mode. We usually don't make improvements for these APIs
and we can't guarantee optimal performance.
## Preview