diff options
| author | octachron <octa@polychoron.fr> | 2017-08-16 11:19:11 +0200 |
|---|---|---|
| committer | octachron <octa@polychoron.fr> | 2017-08-16 11:37:39 +0200 |
| commit | 85390caed84bad19e4e546c69e2b80a901dff7c1 (patch) | |
| tree | 30f11756c94868d422d93e34dbccb0e45ca2d666 | |
| parent | fde2001236a90cacbbefb3cb4a0c62167090cc72 (diff) | |
| download | ocaml-85390caed84bad19e4e546c69e2b80a901dff7c1.tar.gz | |
MPR#7604: minor Ephemeron documentation fixes
| -rw-r--r-- | .mailmap | 1 | ||||
| -rw-r--r-- | Changes | 3 | ||||
| -rw-r--r-- | stdlib/ephemeron.mli | 6 |
3 files changed, 6 insertions, 4 deletions
@@ -88,6 +88,7 @@ Andreas Hauptmann <andreashauptmann@t-online.de> fdopen <andreashauptmann@t-onli Andreas Hauptmann <andreashauptmann@t-online.de> <fdopen@users.noreply.github.com> Hendrik Tews <hendrik@askra.de> Hugo Heuzard <hugo.heuzard@gmail.com> +Miod Vallat <miod@mantis> # These contributors prefer to be referred to pseudonymously whitequark <whitequark@whitequark.org> @@ -188,6 +188,9 @@ Working version caml_example (Florian Angeletti, review and suggestion by Gabriel Scherer) +- MPR#7604: Minor Ephemeron documentation fixes + (Miod Vallat, review by Florian Angeletti) + - GPR#1187: Minimal documentation for compiler plugins (Florian Angeletti) diff --git a/stdlib/ephemeron.mli b/stdlib/ephemeron.mli index 46d3aad361..efa5f661aa 100644 --- a/stdlib/ephemeron.mli +++ b/stdlib/ephemeron.mli @@ -15,14 +15,12 @@ (** Ephemerons and weak hash table *) -(** Ephemerons and weak hash table - - Ephemerons and weak hash table are useful when one wants to cache +(** Ephemerons and weak hash table are useful when one wants to cache or memorize the computation of a function, as long as the arguments and the function are used, without creating memory leaks by continuously keeping old computation results that are not useful anymore because one argument or the function is freed. An - implementation using {Hashtbl.t} is not suitable because all + implementation using {!Hashtbl.t} is not suitable because all associations would keep in memory the arguments and the result. Ephemerons can also be used for "adding" a field to an arbitrary |