From 057300c9ac5c7966546ed2a4f54a0094d3c97907 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Tue, 5 Aug 2014 00:15:17 +0200 Subject: [PATCH] details (comments) --- core/CCIO.mli | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/core/CCIO.mli b/core/CCIO.mli index 2a09c7b3..155c5c2a 100644 --- a/core/CCIO.mli +++ b/core/CCIO.mli @@ -177,7 +177,11 @@ val flush : out_channel -> unit t (* TODO: printf/fprintf wrappers *) -(** {2 Streams} *) +(** {2 Streams} + +Iterators on chunks of bytes, or lines, or any other value using combinators. +Those iterators are usable only once, because their source might +be usable only once (think of a socket) *) module Seq : sig type 'a t @@ -245,7 +249,8 @@ module Seq : sig val output : ?sep:string -> out_channel -> string t -> unit io (** [output oc seq] outputs every value of [seq] into [oc], separated - with the optional argument [sep] (default: ["\n"]) *) + with the optional argument [sep] (default: ["\n"]). + It blocks until all values of [seq] are produced and written to [oc]. *) end (** {2 Low level access} *)