Skip to content

Commit d549cc1

Browse files
committed
I guess Hackage can't handle the backticks in the description
1 parent cbb65ca commit d549cc1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

unfork/unfork.cabal

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ cabal-version: 3.0
22

33
name: unfork
44
version: 1.0.0.0
5+
x-revision: 1
56
category: Concurrency
67
synopsis: Make any action thread safe
78

89
description:
910
“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.
1011

11-
A typical use case is a multi-threaded program that writes log messages. If threads use `putStrLn` directly, the strings may be interleaved in the combined output. Instead, create an unforked version of `putStrLn`:
12+
A typical use case is a multi-threaded program that writes log messages. If threads use @putStrLn@ directly, the strings may be interleaved in the combined output. Instead, create an unforked version of @putStrLn@:
1213

1314
> import Unfork
1415
>
@@ -18,7 +19,7 @@ description:
1819
> _ -- Within this continuation, use
1920
> -- putStrLn' instead of putStrLn
2021

21-
The new `putStrLn'` function writes to a queue. A separate thread reads from the queue and performs the actions, thus ensuring that the actions are all performed in one linear sequence. The main thread returns after the continuation has returned and the queue is empty. If an exception is raised in either thread, both threads halt and the exception is re-raised in the main thread.
22+
The new @putStrLn'@ function writes to a queue. A separate thread reads from the queue and performs the actions, thus ensuring that the actions are all performed in one linear sequence. The main thread returns after the continuation has returned and the queue is empty. If an exception is raised in either thread, both threads halt and the exception is re-raised in the main thread.
2223

2324
copyright: 2022 Mission Valley Software LLC
2425
license: Apache-2.0

0 commit comments

Comments
 (0)