From 159168dd7b7de35caec4f298eccf6423a0c28951 Mon Sep 17 00:00:00 2001
From: DerekTond <30630345+DerekTond@users.noreply.github.com>
Date: Thu, 29 Aug 2024 19:37:42 +0800
Subject: [PATCH] =?UTF-8?q?fix=20=E5=88=A0=E9=99=A4=E6=96=87=E6=A1=A3?=
 =?UTF-8?q?=E4=B8=AD=E5=BA=9F=E5=BC=83=E7=9A=84RetryDuration=E5=87=BD?=
 =?UTF-8?q?=E6=95=B0=20(#240)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* fix 修改文档中已经删除的函数RetryDuration，替换为RetryWithLinearBackoff

* fix 删除主文档中的废弃函数

---------

Co-authored-by: dongyue16 <dongyue16@tal.com>
---
 README_zh-CN.md            |  3 ---
 docs/api/packages/retry.md | 52 +++-----------------------------------
 2 files changed, 3 insertions(+), 52 deletions(-)

diff --git a/README_zh-CN.md b/README_zh-CN.md
index a261320..d8c27d3 100644
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -1200,9 +1200,6 @@ import "github.com/duke-git/lancet/v2/retry"
 -   **<big>RetryFunc</big>** : 重试执行的函数。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/retry.md#RetryFunc)]
     [[play](https://go.dev/play/p/nk2XRmagfVF)]
--   **<big>RetryDuration</big>** : 设置重试间隔时间，默认 3 秒。
-    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/retry.md#RetryDuration)]
-    [[play](https://go.dev/play/p/nk2XRmagfVF)]
 -   **<big>RetryTimes</big>** : 设置重试次数，默认 5。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/retry.md#RetryTimes)]
     [[play](https://go.dev/play/p/ssfVeU2SwLO)]
diff --git a/docs/api/packages/retry.md b/docs/api/packages/retry.md
index 1c065c2..165bd73 100644
--- a/docs/api/packages/retry.md
+++ b/docs/api/packages/retry.md
@@ -70,7 +70,7 @@ func main() {
         return errors.New("error occurs")
     }
 
-    duration := retry.RetryDuration(time.Microsecond*50)
+    duration := retry.RetryWithLinearBackoff(time.Microsecond*50)
 
     retry.Retry(increaseNumber,
         duration,
@@ -116,7 +116,7 @@ func main() {
         return errors.New("error occurs")
     }
 
-    duration := retry.RetryDuration(time.Microsecond*50)
+    duration := retry.RetryWithLinearBackoff(time.Microsecond*50)
 
     err := retry.Retry(increaseNumber, duration)
     if err != nil {
@@ -173,52 +173,6 @@ func main() {
 }
 ```
 
-### <span id="RetryDuration">RetryDuration</span>
-
-<p>设置重试间隔时间，默认3秒</p>
-
-<b>函数签名:</b>
-
-```go
-func RetryDuration(d time.Duration)
-```
-
-<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/nk2XRmagfVF)</span></b>
-
-```go
-package main
-
-import (
-    "fmt"
-    "errors"
-    "log"
-    "github.com/duke-git/lancet/v2/retry"
-)
-
-func main() {
-    number := 0
-    increaseNumber := func() error {
-        number++
-        if number == 3 {
-            return nil
-        }
-        return errors.New("error occurs")
-    }
-
-    duration := retry.RetryDuration(time.Microsecond*50)
-
-    err := retry.Retry(increaseNumber, duration)
-    if err != nil {
-        return
-    }
-
-    fmt.Println(number)
-
-    // Output:
-    // 3
-}
-```
-
 ### <span id="Retry">Retry</span>
 
 <p>重试执行函数retryFunc，直到函数运行成功，或被context停止</p>
@@ -251,7 +205,7 @@ func main() {
         return errors.New("error occurs")
     }
 
-    duration := retry.RetryDuration(time.Microsecond*50)
+    duration := retry.RetryWithLinearBackoff(time.Microsecond*50)
 
     err := retry.Retry(increaseNumber, duration)
     if err != nil {