doc: normalize documents

2026-02-08 06:32:28 +08:00 · 2023-01-13 14:36:33 +08:00
parent 2c6e9a3fb9
commit 4c5524354c
12 changed files with 1800 additions and 1211 deletions
--- a/docs/maputil.md
+++ b/docs/maputil.md
@@ -1,16 +1,17 @@
 # Maputil
+
 Package maputil includes some functions to manipulate map.

 <div STYLE="page-break-after: always;"></div>

 ## Source:

- [https://github.com/duke-git/lancet/blob/main/maputil/map.go](https://github.com/duke-git/lancet/blob/main/maputil/map.go)
-
+-   [https://github.com/duke-git/lancet/blob/main/maputil/map.go](https://github.com/duke-git/lancet/blob/main/maputil/map.go)

 <div STYLE="page-break-after: always;"></div>

 ## Example:
+
 ```go
 import (
    "github.com/duke-git/lancet/v2/maputil"
@@ -20,22 +21,22 @@ import (
 <div STYLE="page-break-after: always;"></div>

 ## Index
- [ForEach](#ForEach)
- [Filter](#Filter)
- [Intersect](#Intersect)
- [Keys](#Keys)
- [Merge](#Merge)
- [Minus](#Minus)
- [Values](#Values)
- [IsDisjoint](#IsDisjoint)
+
+-   [ForEach](#ForEach)
+-   [Filter](#Filter)
+-   [Intersect](#Intersect)
+-   [Keys](#Keys)
+-   [Merge](#Merge)
+-   [Minus](#Minus)
+-   [Values](#Values)
+-   [IsDisjoint](#IsDisjoint)

 <div STYLE="page-break-after: always;"></div>

 ## Documentation

-
-
 ### <span id="ForEach">ForEach</span>
+
 <p>Executes iteratee funcation for every key and value pair in map.</p>

 <b>Signature:</b>
@@ -43,6 +44,7 @@ import (
 ```go
 func ForEach[K comparable, V any](m map[K]V, iteratee func(key K, value V))
 ```
+
 <b>Example:</b>

 ```go
@@ -54,26 +56,28 @@ import (
 )

 func main() {
-	m := map[string]int{
-		"a": 1,
-		"b": 2,
-		"c": 3,
-		"d": 4,
-	}
+    m := map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 3,
+        "d": 4,
+    }

-	var sum int
+    var sum int

-	maputil.ForEach(m, func(_ string, value int) {
-		sum += value
-	})
-	fmt.Println(sum) // 10
+    maputil.ForEach(m, func(_ string, value int) {
+        sum += value
+    })
+
+    fmt.Println(sum)
+
+    // Output:
+    // 10
 }
 ```

-
-
-
 ### <span id="Filter">Filter</span>
+
 <p>Iterates over map, return a new map contains all key and value pairs pass the predicate function.</p>

 <b>Signature:</b>
@@ -81,6 +85,7 @@ func main() {
 ```go
 func Filter[K comparable, V any](m map[K]V, predicate func(key K, value V) bool) map[K]V
 ```
+
 <b>Example:</b>

 ```go
@@ -92,29 +97,32 @@ import (
 )

 func main() {
-	m := map[string]int{
-		"a": 1,
-		"b": 2,
-		"c": 3,
-		"d": 4,
-		"e": 5,
-	}
-	isEven := func(_ string, value int) bool {
-		return value%2 == 0
-	}
+    m := map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 3,
+        "d": 4,
+        "e": 5,
+    }
+    isEven := func(_ string, value int) bool {
+        return value%2 == 0
+    }

-	maputil.Filter(m, func(_ string, value int) {
-		sum += value
-	})
-	res := maputil.Filter(m, isEven)
-	fmt.Println(res) // map[string]int{"b": 2, "d": 4,}
+    maputil.Filter(m, func(_ string, value int) {
+        sum += value
+    })
+    
+    result := maputil.Filter(m, isEven)
+
+    fmt.Println(result)
+
+    // Output:
+    // map[b:2 d:4]
 }
 ```

-
-
-
 ### <span id="Intersect">Intersect</span>
+
 <p>Iterates over maps, return a new map of key and value pairs in all given maps.</p>

 <b>Signature:</b>
@@ -122,6 +130,7 @@ func main() {
 ```go
 func Intersect[K comparable, V any](maps ...map[K]V) map[K]V
 ```
+
 <b>Example:</b>

 ```go
@@ -133,37 +142,42 @@ import (
 )

 func main() {
-	m1 := map[string]int{
-		"a": 1,
-		"b": 2,
-		"c": 3,
-	}
+    m1 := map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 3,
+    }

-	m2 := map[string]int{
-		"a": 1,
-		"b": 2,
-		"c": 6,
-		"d": 7,
-	}
+    m2 := map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 6,
+        "d": 7,
+    }

-	m3 := map[string]int{
-		"a": 1,
-		"b": 9,
-		"e": 9,
-	}
+    m3 := map[string]int{
+        "a": 1,
+        "b": 9,
+        "e": 9,
+    }

-	fmt.Println(maputil.Intersect(m1)) // map[string]int{"a": 1, "b": 2, "c": 3}
+    result1 := maputil.Intersect(m1)
+    result2 := maputil.Intersect(m1, m2)
+    result3 := maputil.Intersect(m1, m2, m3)

-	fmt.Println(maputil.Intersect(m1, m2)) // map[string]int{"a": 1, "b": 2}
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)

-	fmt.Println(maputil.Intersect(m1, m2, m3)) // map[string]int{"a": 1}
+    // Output:
+    // map[a:1 b:2 c:3]
+    // map[a:1 b:2]
+    // map[a:1]
 }
 ```

-
-
-
 ### <span id="Keys">Keys</span>
+
 <p>Returns a slice of the map's keys.</p>

 <b>Signature:</b>
@@ -171,6 +185,7 @@ func main() {
 ```go
 func Keys[K comparable, V any](m map[K]V) []K
 ```
+
 <b>Example:</b>

 ```go
@@ -182,24 +197,26 @@ import (
 )

 func main() {
-	m := map[int]string{
-		1: "a",
-		2: "a",
-		3: "b",
-		4: "c",
-		5: "d",
-	}
+    m := map[int]string{
+        1: "a",
+        2: "a",
+        3: "b",
+        4: "c",
+        5: "d",
+    }

-	keys := maputil.Keys(m)
-	sort.Ints(keys)
-	fmt.Println(keys) // []int{1, 2, 3, 4, 5}
+    keys := maputil.Keys(m)
+    sort.Ints(keys)
+    
+    fmt.Println(keys)
+
+    // Output:
+    // [1 2 3 4 5]
 }
 ```

-
-
-
 ### <span id="Merge">Merge</span>
+
 <p>Merge maps, next key will overwrite previous key.</p>

 <b>Signature:</b>
@@ -207,6 +224,7 @@ func main() {
 ```go
 func Merge[K comparable, V any](maps ...map[K]V) map[K]V
 ```
+
 <b>Example:</b>

 ```go
@@ -218,22 +236,26 @@ import (
 )

 func main() {
-	m1 := map[int]string{
-		1: "a",
-		2: "b",
-	}
-	m2 := map[int]string{
-		1: "1",
-		3: "2",
-	}
-	fmt.Println(maputil.Merge(m1, m2)) // map[int]string{1:"1", 2:"b", 3:"2",}
+    m1 := map[int]string{
+        1: "a",
+        2: "b",
+    }
+    m2 := map[int]string{
+        1: "1",
+        3: "2",
+    }
+
+    result := maputil.Merge(m1, m2)
+
+    fmt.Println(result)
+
+    // Output:
+    // map[1:c 2:b 3:d]
 }
 ```

-
-
-
 ### <span id="Minus">Minus</span>
+
 <p>Creates an map of whose key in mapA but not in mapB.</p>

 <b>Signature:</b>
@@ -241,6 +263,7 @@ func main() {
 ```go
 func Minus[K comparable, V any](mapA, mapB map[K]V) map[K]V
 ```
+
 <b>Example:</b>

 ```go
@@ -252,25 +275,29 @@ import (
 )

 func main() {
-	m1 := map[string]int{
-		"a": 1,
-		"b": 2,
-		"c": 3,
-	}
+    m1 := map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 3,
+    }

-	m2 := map[string]int{
-		"a": 11,
-		"b": 22,
-		"d": 33,
-	}
+    m2 := map[string]int{
+        "a": 11,
+        "b": 22,
+        "d": 33,
+    }
+    
+    result := maputil.Minus(m1, m2)

-	fmt.Println(maputil.Minus(m1, m2)) //map[string]int{"c": 3}
+    fmt.Println(result)
+
+    // Output:
+    // map[c:3]
 }
 ```

-
-
 ### <span id="Values">Values</span>
+
 <p>Returns a slice of the map's values.</p>

 <b>Signature:</b>
@@ -278,6 +305,7 @@ func main() {
 ```go
 func Values[K comparable, V any](m map[K]V) []V
 ```
+
 <b>Example:</b>

 ```go
@@ -289,22 +317,26 @@ import (
 )

 func main() {
-	m := map[int]string{
-		1: "a",
-		2: "a",
-		3: "b",
-		4: "c",
-		5: "d",
-	}
+    m := map[int]string{
+        1: "a",
+        2: "a",
+        3: "b",
+        4: "c",
+        5: "d",
+    }

-	values := maputil.Values(m)
-	sort.Strings(values)
+    values := maputil.Values(m)
+    sort.Strings(values)

-	fmt.Println(values) // []string{"a", "a", "b", "c", "d"}
+    fmt.Println(values)
+
+    // Output:
+    // [a a b c d]
 }
 ```

 ### <span id="IsDisjoint">IsDisjoint</span>
+
 <p>Checks two maps are disjoint if they have no keys in common</p>

 <b>Signature:</b>
@@ -312,6 +344,7 @@ func main() {
 ```go
 func IsDisjoint[K comparable, V any](mapA, mapB map[K]V) bool
 ```
+
 <b>Example:</b>

 ```go
@@ -323,30 +356,28 @@ import (
 )

 func main() {
-	m1 := map[int]string{
-		1: "a",
-		2: "a",
-		3: "b",
-		4: "c",
-		5: "d",
-	}
+    m1 := map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 3,
+    }

-	m2 := map[int]string{
-		1: "a",
-		2: "a",
-		3: "b",
-		4: "c",
-		5: "d",
-	}
+    m2 := map[string]int{
+        "d": 22,
+    }

-	m3 := map[int]string{
-		6: "a",
-	}
+    m3 := map[string]int{
+        "a": 22,
+    }

-	ok := maputil.IsDisjoint(m2, m1)
-	fmt.Println(ok) // false
+    result1 := maputil.IsDisjoint(m1, m2)
+    result2 := maputil.IsDisjoint(m1, m3)

-	ok = maputil.IsDisjoint(m2, m3)
-	fmt.Println(ok) // true
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
 }
-```
+```