From 52b8ea816690f7426971eee9d1f2b76faf3a7cdf Mon Sep 17 00:00:00 2001
From: dudaodong <lanliddd.2007@163.com>
Date: Thu, 7 Dec 2023 19:13:05 +0800
Subject: [PATCH] doc: update doc for random package

---
 docs/api/packages/random.md    | 26 ++++++++++++++++++++++++++
 docs/en/api/packages/random.md | 27 +++++++++++++++++++++++++++
 random/random.go               | 11 ++++++-----
 3 files changed, 59 insertions(+), 5 deletions(-)

diff --git a/docs/api/packages/random.md b/docs/api/packages/random.md
index 99aaf03..e68e2af 100644
--- a/docs/api/packages/random.md
+++ b/docs/api/packages/random.md
@@ -218,6 +218,32 @@ func main() {
 }
 ```
 
+### <span id="RandSymbolChar">RandSymbolChar</span>
+
+<p>生成给定长度的随机符号字符串. 符号字符包括: !@#$%^&*()_+-=[]{}|;':\",./<>?。</p>
+
+<b>函数签名:</b>
+
+```go
+func RandSymbolChar(length int) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/random"
+)
+
+func main() {
+    randStr := random.RandSymbolChar(6)
+    fmt.Println(randStr) //@#(_")
+}
+```
+
 ### <span id="UUIdV4">UUIdV4</span>
 
 <p>生成UUID v4字符串</p>
diff --git a/docs/en/api/packages/random.md b/docs/en/api/packages/random.md
index ed5531d..74381cd 100644
--- a/docs/en/api/packages/random.md
+++ b/docs/en/api/packages/random.md
@@ -29,6 +29,7 @@ import (
 -   [RandLower](#RandLower)
 -   [RandNumeral](#RandNumeral)
 -   [RandNumeralOrLetter](#RandNumeralOrLetter)
+-   [RandSymbolChar](#RandSymbolChar)
 -   [UUIdV4](#UUIdV4)
 -   [RandUniqueIntSlice](#RandUniqueIntSlice)
 
@@ -218,6 +219,32 @@ func main() {
 }
 ```
 
+### <span id="RandSymbolChar">RandSymbolChar</span>
+
+<p>Generate a random symbol char of specified length. Symbol chars: !@#$%^&*()_+-=[]{}|;':\",./<>?.</p>
+
+<b>Signature:</b>
+
+```go
+func RandSymbolChar(length int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/random"
+)
+
+func main() {
+    randStr := random.RandSymbolChar(6)
+    fmt.Println(randStr) //@#(_")
+}
+```
+
 ### <span id="UUIdV4">UUIdV4</span>
 
 <p>Generate a random UUID of version 4 according to RFC 4122.</p>
diff --git a/random/random.go b/random/random.go
index af2a33a..2e0b811 100644
--- a/random/random.go
+++ b/random/random.go
@@ -53,19 +53,19 @@ func RandBytes(length int) []byte {
 	return b
 }
 
-// RandString generate random string of specified length.
+// RandString generate random alpha string of specified length.
 // Play: https://go.dev/play/p/W2xvRUXA7Mi
 func RandString(length int) string {
 	return random(Letters, length)
 }
 
-// RandUpper generate a random upper case string.
+// RandUpper generate a random upper case string of specified length.
 // Play: https://go.dev/play/p/29QfOh0DVuh
 func RandUpper(length int) string {
 	return random(UpperLetters, length)
 }
 
-// RandLower generate a random lower case string.
+// RandLower generate a random lower case string of specified length.
 // Play: https://go.dev/play/p/XJtZ471cmtI
 func RandLower(length int) string {
 	return random(LowwerLetters, length)
@@ -77,13 +77,14 @@ func RandNumeral(length int) string {
 	return random(Numeral, length)
 }
 
-// RandNumeralOrLetter generate a random numeral or letter string.
+// RandNumeralOrLetter generate a random numeral or alpha string of specified length.
 // Play: https://go.dev/play/p/19CEQvpx2jD
 func RandNumeralOrLetter(length int) string {
 	return random(Numeral+Letters, length)
 }
 
-// RandSymbolChar generate a random symbol char(!@#$%^&*()_+-=[]{}|;':\",./<>?).
+// RandSymbolChar generate a random symbol char of specified length.
+// symbol chars: !@#$%^&*()_+-=[]{}|;':\",./<>?.
 // Play: todo
 func RandSymbolChar(length int) string {
 	return random(SymbolChars, length)