From 23a01359475f764e618c25883b999854b037d4ac Mon Sep 17 00:00:00 2001
From: dudaodong <lanliddd.2007@163.com>
Date: Wed, 7 Jun 2023 14:21:29 +0800
Subject: [PATCH] doc: add doc for RandUniqueIntSlice

---
 docs/random.md                | 28 ++++++++++++++++++++++++++++
 docs/random_zh-CN.md          | 27 +++++++++++++++++++++++++++
 random/random.go              |  3 ++-
 random/random_example_test.go |  1 +
 4 files changed, 58 insertions(+), 1 deletion(-)

diff --git a/docs/random.md b/docs/random.md
index 62506b1..eac6d82 100644
--- a/docs/random.md
+++ b/docs/random.md
@@ -30,6 +30,7 @@ import (
 -   [RandNumeral](#RandNumeral)
 -   [RandNumeralOrLetter](#RandNumeralOrLetter)
 -   [UUIdV4](#UUIdV4)
+-   [RandUniqueIntSlice](#RandUniqueIntSlice)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -245,3 +246,30 @@ func main() {
     fmt.Println(uuid)
 }
 ```
+
+
+### <span id="RandUniqueIntSlice">RandUniqueIntSlice</span>
+
+<p>Generate a slice of random int of length n that do not repeat.</p>
+
+<b>Signature:</b>
+
+```go
+func RandUniqueIntSlice(n, min, max int) []int
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/random"
+)
+
+func main() {
+    result := RandUniqueIntSlice(5, 0, 10)
+    fmt.Println(result) //[0 4 7 1 5] (random)
+}
+```
diff --git a/docs/random_zh-CN.md b/docs/random_zh-CN.md
index af51a84..4cf38ec 100644
--- a/docs/random_zh-CN.md
+++ b/docs/random_zh-CN.md
@@ -30,6 +30,7 @@ import (
 -   [RandNumeral](#RandNumeral)
 -   [RandNumeralOrLetter](#RandNumeralOrLetter)
 -   [UUIdV4](#UUIdV4)
+-   [RandUniqueIntSlice](#RandUniqueIntSlice)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -245,3 +246,29 @@ func main() {
     fmt.Println(uuid)
 }
 ```
+
+### <span id="RandUniqueIntSlice">RandUniqueIntSlice</span>
+
+<p>生成一个不重复的长度为n的随机int切片。</p>
+
+<b>函数签名:</b>
+
+```go
+func RandUniqueIntSlice(n, min, max int) []int
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/random"
+)
+
+func main() {
+    result := RandUniqueIntSlice(5, 0, 10)
+    fmt.Println(result) //[0 4 7 1 5] (random)
+}
+```
diff --git a/random/random.go b/random/random.go
index d551d74..698caf8 100644
--- a/random/random.go
+++ b/random/random.go
@@ -115,7 +115,8 @@ func UUIdV4() (string, error) {
 	return fmt.Sprintf("%x-%x-%x-%x-%x", uuid[0:4], uuid[4:6], uuid[6:8], uuid[8:10], uuid[10:]), nil
 }
 
-// RandUniqueIntSlice generate a slice of random int of length n that do not repeat
+// RandUniqueIntSlice generate a slice of random int of length n that do not repeat.
+// Play: todo
 func RandUniqueIntSlice(n, min, max int) []int {
 	if min > max {
 		return []int{}
diff --git a/random/random_example_test.go b/random/random_example_test.go
index e2f6032..c5629f2 100644
--- a/random/random_example_test.go
+++ b/random/random_example_test.go
@@ -130,6 +130,7 @@ func ExampleRandUniqueIntSlice() {
 	if len(result) == 5 {
 		fmt.Println("ok")
 	}
+	fmt.Println(result)
 
 	// Output:
 	// ok