aboutsummaryrefslogtreecommitdiff
path: root/docs/threads.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-03-05 00:40:00 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-03-05 00:40:00 -0500
commit9a3162633d358c9dc698b2733027981203514dc9 (patch)
tree38f6ebd8121f5dab2f04173dda8b9cefd2de1fdf /docs/threads.md
parentdba2d62d15d8233c189a109f97d7cda70fa7f6b7 (diff)
Shorten API docs
Diffstat (limited to 'docs/threads.md')
-rw-r--r--docs/threads.md16
1 files changed, 0 insertions, 16 deletions
diff --git a/docs/threads.md b/docs/threads.md
index 67402ecc..4d8f8962 100644
--- a/docs/threads.md
+++ b/docs/threads.md
@@ -12,8 +12,6 @@ through [mutex-guarded datastructures](mutexed.md).
- [`func new(fn: func(->Void) -> Thread)`](#new)
### `cancel`
-
-**Description:**
Requests the cancellation of a specified thread.
**Signature:**
@@ -21,8 +19,6 @@ Requests the cancellation of a specified thread.
func cancel(thread: Thread)
```
-**Parameters:**
-
- `thread`: The thread to cancel.
**Returns:**
@@ -36,8 +32,6 @@ Nothing.
---
### `detach`
-
-**Description:**
Detaches a specified thread, allowing it to run independently.
**Signature:**
@@ -45,8 +39,6 @@ Detaches a specified thread, allowing it to run independently.
func detach(thread: Thread)
```
-**Parameters:**
-
- `thread`: The thread to detach.
**Returns:**
@@ -57,8 +49,6 @@ Nothing.
>> thread:detach()
```
### `join`
-
-**Description:**
Waits for a specified thread to terminate.
**Signature:**
@@ -66,8 +56,6 @@ Waits for a specified thread to terminate.
func join(thread: Thread)
```
-**Parameters:**
-
- `thread`: The thread to join.
**Returns:**
@@ -81,8 +69,6 @@ Nothing.
---
### `new`
-
-**Description:**
Creates a new thread to execute a specified function.
**Signature:**
@@ -90,8 +76,6 @@ Creates a new thread to execute a specified function.
func new(fn: func(->Void) -> Thread)
```
-**Parameters:**
-
- `fn`: The function to be executed by the new thread.
**Returns:**