Skip to content

Commit 213ea2a

Browse files
committed
Reformat and correct phrase
1 parent 10722c6 commit 213ea2a

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

.prettierrc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"arrowParens": "avoid",
3+
"bracketSpacing": false,
4+
"printWidth": 80,
5+
"semi": false,
6+
"singleQuote": true,
7+
"proseWrap": "always"
8+
}

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ run on [current-bench](https://github.com/ocurrent/current-bench).
77

88
Benchmarking multicore algorithms tends to a require certain amount of setup,
99
such as spawning domains, synchronizing them before work, timing the work,
10-
collecting the times, and joining domains, that this framework tries to care of
11-
for you as conveniently as possible. Furthermore, benchmarking multicore
10+
collecting the times, and joining domains, that this framework tries to take
11+
care of for you as conveniently as possible. Furthermore, benchmarking multicore
1212
algorithms in OCaml also involves a number of pitfalls related to how the OCaml
1313
runtime works. For example, when only a single domain is running, several
1414
operations provided by the OCaml runtime use specialized implementations that
@@ -34,7 +34,9 @@ benchmarks from the
3434
[Saturn](https://github.com/ocaml-multicore/saturn/tree/main/bench) and
3535
[Kcas](https://github.com/ocaml-multicore/kcas/tree/main/bench) libraries.
3636

37-
We first open the [`Multicore_bench`](https://ocaml-multicore.github.io/multicore-bench/doc/multicore-bench/Multicore_bench/index.html) module:
37+
We first open the
38+
[`Multicore_bench`](https://ocaml-multicore.github.io/multicore-bench/doc/multicore-bench/Multicore_bench/index.html)
39+
module:
3840

3941
```ocaml
4042
# open Multicore_bench
@@ -158,7 +160,8 @@ val benchmarks : (string * Suite.t) list = [("Atomic", <fun>)]
158160
```
159161

160162
Usually the list of benchmarks is in the main module of the benchmark executable
161-
along with an invocation of [`Cmd.run`](https://ocaml-multicore.github.io/multicore-bench/doc/multicore-bench/Multicore_bench/Cmd/index.html#val-run):
163+
along with an invocation of
164+
[`Cmd.run`](https://ocaml-multicore.github.io/multicore-bench/doc/multicore-bench/Multicore_bench/Cmd/index.html#val-run):
162165

163166
```ocaml non-deterministic
164167
# Cmd.run ~benchmarks ~argv:[||] ()

0 commit comments

Comments
 (0)