Skip to content

Commit cbb65ca

Browse files
committed
reorder doc intro
1 parent adea7c6 commit cbb65ca

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

readme.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# Unfork
22

3-
“Unfork” is the opposite of “fork”; whereas forking allows things to run concurrently, unforking prevents things from running concurrently.
3+
“Unfork” is the opposite of “fork”; whereas forking allows things to run concurrently, unforking prevents things from running concurrently. Use one of the functions in the `Unfork` module when you have an action that will be used by concurrent threads but needs to run serially.
44

55
| | Result available | Result discarded |
66
| ----------- | ------------------ | ------------------ |
77
| Async I/O | `unforkAsyncIO` | `unforkAsyncIO_` |
88
| Async STM | `unforkAsyncSTM` | `unforkAsyncSTM_` |
99
| Sync I/O | `unforkSyncIO` | `unforkSyncIO_` |
1010

11-
Use one of the functions in the `Unfork` module when you have an action that will be used by concurrent threads but needs to run serially.
12-
1311

1412
## Example
1513

unfork/Unfork.hs

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{- |
22
3-
“Unfork” is the opposite of “fork”; whereas forking allows things to run concurrently, unforking prevents things from running concurrently.
3+
“Unfork” is the opposite of “fork”; whereas forking allows things to run concurrently, unforking prevents things from running concurrently. Use one of the functions in this module when you have an action that will be used by concurrent threads but needs to run serially.
44
55
+-----------+------------------+-------------------+
66
| | Result available | Result discarded |
@@ -12,8 +12,6 @@
1212
| Sync I/O | 'unforkSyncIO' | 'unforkSyncIO_' |
1313
+-----------+------------------+-------------------+
1414
15-
Use one of the functions in this module when you have an action that will be used by concurrent threads but needs to run serially.
16-
1715
1816
== Example
1917

0 commit comments

Comments
 (0)