docs: autoupdate

atomicgo · Jul 19, 2024 · beabd89 · beabd89
1 parent 29b50c8
commit beabd89
Showing 1 changed file with 38 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,20 @@
+<!--
+
+
+
+┌───────────────────────────────────────────────────────────────────┐
+│                                                                   │
+│                          IMPORTANT NOTE                           │
+│                                                                   │
+│               This file is automatically generated                │
+│           All manual modifications will be overwritten            │
+│                                                                   │
+└───────────────────────────────────────────────────────────────────┘
+
+
+
+-->
+
 <h1 align="center">AtomicGo | stack</h1>
 
 <p align="center">
@@ -16,7 +33,7 @@
 </a>
 
 <a href="https://codecov.io/gh/atomicgo/stack">
-<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-0-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
+<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-23-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
 </a>
 
 <a href="https://opensource.org/licenses/MIT" target="_blank">
@@ -107,8 +124,7 @@ func New[T any]() Stack[T]
 
 New returns a new stack.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -124,8 +140,7 @@ func main() {
 }
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].Clear"></a>
 ### func \(\*Stack\[T\]\) [Clear](<https://github.com/atomicgo/stack/blob/main/stack.go#L58>)
@@ -136,8 +151,7 @@ func (s *Stack[T]) Clear()
 
 Clear removes all items from the stack.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -168,8 +182,7 @@ func main() {
 []
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].Contains"></a>
 ### func \(\*Stack\[T\]\) [Contains](<https://github.com/atomicgo/stack/blob/main/stack.go#L63>)
@@ -180,8 +193,7 @@ func (s *Stack[T]) Contains(item T) bool
 
 Contains returns true if the stack contains the item.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -212,8 +224,7 @@ true
 false
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].IsEmpty"></a>
 ### func \(\*Stack\[T\]\) [IsEmpty](<https://github.com/atomicgo/stack/blob/main/stack.go#L43>)
@@ -224,8 +235,7 @@ func (s *Stack[T]) IsEmpty() bool
 
 IsEmpty returns true if the stack is empty.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -259,8 +269,7 @@ false
 true
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].Peek"></a>
 ### func \(\*Stack\[T\]\) [Peek](<https://github.com/atomicgo/stack/blob/main/stack.go#L53>)
@@ -280,8 +289,7 @@ func (s *Stack[T]) Pop() T
 
 Pop removes an item from the stack and returns it. Panics if the stack is empty. Use PopSafe for safer access to the Stack.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -312,8 +320,7 @@ World
 Hello
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].PopSafe"></a>
 ### func \(\*Stack\[T\]\) [PopSafe](<https://github.com/atomicgo/stack/blob/main/stack.go#L34>)
@@ -324,8 +331,7 @@ func (s *Stack[T]) PopSafe() T
 
 PopSafe removes an item from the stack and returns it. Returns the zero value of the type if the stack is empty. To make this function safe, it uses reflection and is therefore slower than Pop.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -357,8 +363,7 @@ World
 Hello
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].Push"></a>
 ### func \(\*Stack\[T\]\) [Push](<https://github.com/atomicgo/stack/blob/main/stack.go#L19>)
@@ -369,8 +374,7 @@ func (s *Stack[T]) Push(item ...T)
 
 Push adds items to a stack.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -399,8 +403,7 @@ func main() {
 [Hello World]
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].Size"></a>
 ### func \(\*Stack\[T\]\) [Size](<https://github.com/atomicgo/stack/blob/main/stack.go#L48>)
@@ -411,8 +414,7 @@ func (s *Stack[T]) Size() int
 
 Size returns the size of the stack.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -441,8 +443,7 @@ func main() {
 2
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].String"></a>
 ### func \(Stack\[T\]\) [String](<https://github.com/atomicgo/stack/blob/main/stack.go#L77>)
@@ -453,8 +454,7 @@ func (s Stack[T]) String() string
 
 
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -483,8 +483,7 @@ func main() {
 [Hello World]
 ```
 
-</p>
-</details>
+
 
 <a name="Stack[T].Values"></a>
 ### func \(\*Stack\[T\]\) [Values](<https://github.com/atomicgo/stack/blob/main/stack.go#L73>)
@@ -495,8 +494,7 @@ func (s *Stack[T]) Values() []T
 
 Values returns the values of the stack as a slice.
 
-<details><summary>Example</summary>
-<p>
+
 
 
 
@@ -525,8 +523,7 @@ func main() {
 [Hello World]
 ```
 
-</p>
-</details>
+
 
 Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)