diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2024-10-09 13:48:45 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2024-10-09 13:48:45 -0400 |
| commit | 5a80ff0db3690943a522e38152c86393ab0eb594 (patch) | |
| tree | e9acbe040b9216dc456b8d7f99852a42800ff998 /docs/threads.md | |
| parent | 63d48e9febf2aa65de4cfd40489b05cbcdfd463a (diff) | |
Update docs to standardize function signature formatting
Diffstat (limited to 'docs/threads.md')
| -rw-r--r-- | docs/threads.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/threads.md b/docs/threads.md index 1580df8c..ab0ce399 100644 --- a/docs/threads.md +++ b/docs/threads.md @@ -11,9 +11,9 @@ through thread-safe Channels with no other shared data. **Description:** Creates a new thread to execute a specified function. -**Usage:** +**Signature:** ```tomo -Thread.new(fn: func(->Void) -> Thread) +func new(fn: func(->Void) -> Thread) ``` **Parameters:** @@ -45,9 +45,9 @@ A new `Thread` object representing the created thread. **Description:** Requests the cancellation of a specified thread. -**Usage:** +**Signature:** ```tomo -cancel(thread: Thread) +func cancel(thread: Thread) ``` **Parameters:** @@ -69,9 +69,9 @@ Nothing. **Description:** Waits for a specified thread to terminate. -**Usage:** +**Signature:** ```tomo -join(thread: Thread) +func join(thread: Thread) ``` **Parameters:** @@ -93,9 +93,9 @@ Nothing. **Description:** Detaches a specified thread, allowing it to run independently. -**Usage:** +**Signature:** ```tomo -detach(thread: Thread) +func detach(thread: Thread) ``` **Parameters:** |
