Skip to content

Commit

Permalink
docs: autoupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Jul 19, 2024
1 parent c52b4a4 commit 9c0ca6b
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
<!--
┌───────────────────────────────────────────────────────────────────┐
│ │
│ IMPORTANT NOTE │
│ │
│ This file is automatically generated │
│ All manual modifications will be overwritten │
│ │
└───────────────────────────────────────────────────────────────────┘
-->

<h1 align="center">AtomicGo | timeout</h1>

<p align="center">
Expand Down Expand Up @@ -71,8 +88,7 @@ import "atomicgo.dev/timeout"

Package timeout provides a simple way to add timeouts to your Go code. The Execute function is blocking, so you can use it as a drop\-in replacement for your function calls. Timeouts are often useful in scripts, where you want to limit the execution time of a function.

<details><summary>Example (Timeout Not Reached)</summary>
<p>




Expand Down Expand Up @@ -101,11 +117,9 @@ func main() {
Hello, World! <nil>
```

</p>
</details>

<details><summary>Example (Timeout Reached)</summary>
<p>





Expand Down Expand Up @@ -134,11 +148,9 @@ func main() {
timeout reached
```

</p>
</details>

<details><summary>Example (Timeout With Error)</summary>
<p>





Expand Down Expand Up @@ -168,8 +180,7 @@ func main() {
some error
```

</p>
</details>


## Index

Expand Down

0 comments on commit 9c0ca6b

Please sign in to comment.