Skip to content

Commit 85390ca

Browse files
committed
MPR#7604: minor Ephemeron documentation fixes
1 parent fde2001 commit 85390ca

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

.mailmap

+1
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ Andreas Hauptmann <andreashauptmann@t-online.de> fdopen <andreashauptmann@t-onli
8888
Andreas Hauptmann <andreashauptmann@t-online.de> <fdopen@users.noreply.github.com>
8989
Hendrik Tews <hendrik@askra.de>
9090
Hugo Heuzard <hugo.heuzard@gmail.com>
91+
Miod Vallat <miod@mantis>
9192

9293
# These contributors prefer to be referred to pseudonymously
9394
whitequark <whitequark@whitequark.org>

Changes

+3
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,9 @@ Working version
188188
caml_example
189189
(Florian Angeletti, review and suggestion by Gabriel Scherer)
190190

191+
- MPR#7604: Minor Ephemeron documentation fixes
192+
(Miod Vallat, review by Florian Angeletti)
193+
191194
- GPR#1187: Minimal documentation for compiler plugins
192195
(Florian Angeletti)
193196

stdlib/ephemeron.mli

+2-4
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,12 @@
1515

1616
(** Ephemerons and weak hash table *)
1717

18-
(** Ephemerons and weak hash table
19-
20-
Ephemerons and weak hash table are useful when one wants to cache
18+
(** Ephemerons and weak hash table are useful when one wants to cache
2119
or memorize the computation of a function, as long as the
2220
arguments and the function are used, without creating memory leaks
2321
by continuously keeping old computation results that are not
2422
useful anymore because one argument or the function is freed. An
25-
implementation using {Hashtbl.t} is not suitable because all
23+
implementation using {!Hashtbl.t} is not suitable because all
2624
associations would keep in memory the arguments and the result.
2725
2826
Ephemerons can also be used for "adding" a field to an arbitrary

0 commit comments

Comments
 (0)