Skip to content

Commit 04bd5db

Browse files
committed
More typos
1 parent a15fd85 commit 04bd5db

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ These are smaller and closer to OCaml's built-in Map and Set, however:
282282
- Our library allows using any type `key` that comes with an injective `to_int`
283283
function, instead of requiring `key = int`.
284284
- We support generic (heterogeneous) types for keys/elements.
285-
- We support operation between sets and maps of different types.
285+
- We support operations between sets and maps of different types.
286286
- We use a big-endian representation, allowing easy access to min/max elements of
287287
maps and trees.
288288
- Our interface and implementation tries to maximize the sharing between different
@@ -298,8 +298,11 @@ Additionally, there is a dependent map library: [dmap](https://gitlab.inria.fr/b
298298
It allows creating type safe dependent maps similar to our heterogeneous maps.
299299
However, its maps aren't Patricia trees. They are binary trees build using a
300300
(polymorphic) comparison function, similarly to the maps of the standard library.
301-
Another difference is that the type of values in the map is independent from the type of the keys,
302-
(allowing keys to be associated with different values in different maps).
301+
302+
Another difference is that the type of values in the map is independent of the type of the keys,
303+
allowing keys to be associated with different values in different maps. i.e.
304+
we map `'a key` to any `('a, 'b) value` type, whereas dmap only maps `'a key`
305+
to `'a`.
303306

304307
`dmap` also works with OCaml `>= 4.12`, whereas we require OCaml `>= 4.14`.
305308

RELEASE_CHECKLIST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Step-by-step guide to creating and publishing a new release.
2222
```bash
2323
git push origin vX.Y.Z
2424
```
25-
Check that github-action succeeds (build, tests and documentation).
25+
Check that [github-action](https://github.com/codex-semantics-library/patricia-tree/actions) succeeds (build, tests and documentation).
2626
It should create a new folder `vX.Y.Z` on the `gh-pages` branch.
2727

2828
5. On the `gh-pages` branch, edit `index.html` to add a link to the new version

index.mld

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,8 @@ away as we would like a bit more time using this library before doing so.
258258
{1 Known issues}
259259

260260
There is a bug in the OCaml typechecker which prevents us from directly
261-
defining non-generic maps as instances of generic maps. To avoid this, non-generic maps use a separate value type (instead of just using `'b`)
261+
defining non-generic maps as instances of generic maps. To avoid this, non-generic maps
262+
use a separate value type (instead of just using ['b])
262263
{[
263264
type (_, 'b) snd = Snd of 'b [@@unboxed]
264265
]}
@@ -278,7 +279,7 @@ These are smaller and closer to OCaml's built-in [Map] and [Set], however:
278279
- Our library allows using any type [key] that comes with an injective [to_int]
279280
function, instead of requiring [key = int].
280281
- We support generic types for keys/elements.
281-
- We support operation between sets and maps of different types.
282+
- We support operations between sets and maps of different types.
282283
- We use a big-endian representation, allowing easy access to min/max elements of
283284
maps and trees.
284285
- Our interface and implementation tries to maximize the sharing between different
@@ -294,8 +295,11 @@ Additionally, there is a dependent map library: {{: https://gitlab.inria.fr/bmon
294295
It allows creating type safe dependent maps similar to our heterogeneous maps.
295296
However, its maps aren't Patricia trees. They are binary trees build using a
296297
(polymorphic) comparison function, similarly to the maps of the standard library.
297-
Another difference is that the type of values in the map is independent from the type of the keys,
298-
(allowing keys to be associated with different values in different maps).
298+
299+
Another difference is that the type of values in the map is independent from the
300+
type of the keys, allowing keys to be associated with different values in different maps.
301+
i.e. we map ['a key] to any [('a, 'b) value] type, whereas dmap only maps ['a key]
302+
to ['a].
299303

300304
[dmap] also works with OCaml [>= 4.12], whereas we require OCaml [>= 4.14].
301305

0 commit comments

Comments
 (0)