From ac4494e70792eadce2226fdcc789f4306893b566 Mon Sep 17 00:00:00 2001 From: Sven Anderson Date: Fri, 1 Oct 2021 17:16:29 +0900 Subject: [PATCH] docs: use Go convention for deprectated APIs Signed-off-by: Sven Anderson --- docs/api-stability.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/api-stability.md b/docs/api-stability.md index f87e8cc..acc892a 100644 --- a/docs/api-stability.md +++ b/docs/api-stability.md @@ -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