mirror of https://github.com/ceph/go-ceph
docs: use Go convention for deprectated APIs
Signed-off-by: Sven Anderson <sven@redhat.com>
This commit is contained in:
parent
97630486ee
commit
ac4494e707
|
@ -17,12 +17,13 @@ convention in the Go community.
|
||||||
## Deprecated
|
## Deprecated
|
||||||
|
|
||||||
This is a level for APIs that should not be used for new code. These are marked
|
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
|
as deprecated according to Go conventions in the documentation (that is, a
|
||||||
removed in a future release, especially the 1.0 release, so we recommend
|
paragraph beginning with _Deprecated:_). During 0.x releases these APIs
|
||||||
refactoring the code at the earliest convenience. After the 1.0 release,
|
might get removed in a future release, especially the 1.0 release, so we
|
||||||
deprecated APIs will not be removed, however they are still deprecated and only
|
recommend refactoring the code at the earliest convenience. After the 1.0
|
||||||
in maintanence mode. We usually don't make improvements for these APIs and we
|
release, deprecated APIs will not be removed, however they are still deprecated
|
||||||
can't guarantee optimal performance.
|
and only in maintanence mode. We usually don't make improvements for these APIs
|
||||||
|
and we can't guarantee optimal performance.
|
||||||
|
|
||||||
## Preview
|
## Preview
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue