summaryrefslogtreecommitdiff
path: root/stdlib/buffer.mli
diff options
context:
space:
mode:
authorDamien Doligez <damien.doligez-inria.fr>1999-10-02 12:09:43 +0000
committerDamien Doligez <damien.doligez-inria.fr>1999-10-02 12:09:43 +0000
commit10270afb112bac01eebd018cf525de3493c856b4 (patch)
tree607e54bed613cfeaa90fb0d1f0c4eb31c27ac054 /stdlib/buffer.mli
parent3f10f2b54d33bf4cb65f6fd63e44b2b5f6eaf57d (diff)
downloadocaml-10270afb112bac01eebd018cf525de3493c856b4.tar.gz
array.mli: documentation des cas d'erreur de make, make_matrix
string.mli: documentation des cas d'erreur de create, make buffer.ml, buffer.mli: blindage de create hashtbl.ml, hashtbl.mli: blindage de create pervasives.ml: fix typo dans bool_of_string gc.mli: utilisation de {r with l=v} dans l'exemple git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@2411 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/buffer.mli')
-rw-r--r--stdlib/buffer.mli4
1 files changed, 3 insertions, 1 deletions
diff --git a/stdlib/buffer.mli b/stdlib/buffer.mli
index 13900de279..297d3d53fc 100644
--- a/stdlib/buffer.mli
+++ b/stdlib/buffer.mli
@@ -29,7 +29,9 @@ val create : int -> t
as the number of characters that are expected to be stored in
the buffer (for instance, 80 for a buffer that holds one output
line). Nothing bad will happen if the buffer grows beyond that
- limit, however. In doubt, take [n = 16] for instance. *)
+ limit, however. In doubt, take [n = 16] for instance.
+ If [n] is not between 1 and [Sys.max_string_length], it will
+ be clipped to that interval. *)
val contents : t -> string
(* Return a copy of the current contents of the buffer.
The buffer itself is unchanged. *)