diff --git a/doc/intro.txt b/doc/intro.txt index 631dec78..231aab21 100644 --- a/doc/intro.txt +++ b/doc/intro.txt @@ -68,6 +68,7 @@ CCBV CCCache CCFQueue CCFlatHashtbl +CCMixmap CCMixtbl CCMultiMap CCMultiSet @@ -131,6 +132,16 @@ UnionFind Univ } +{4 Lwt} + +Utils for Lwt (including experimental stuff) + +{!modules: +Lwt_actor +Lwt_klist +Lwt_pipe +} + {4 Others} {!modules: diff --git a/src/data/CCMixtbl.mli b/src/data/CCMixtbl.mli index 67af7755..a315b41a 100644 --- a/src/data/CCMixtbl.mli +++ b/src/data/CCMixtbl.mli @@ -82,8 +82,8 @@ val set : inj:'b injection -> 'a t -> 'a -> 'b -> unit val find : inj:'b injection -> 'a t -> 'a -> 'b (** Find the value for the given key, which must be of the right type. - raises Not_found if either the key is not found, or if its value - doesn't belong to the right type *) + @raise Not_found if either the key is not found, or if its value + doesn't belong to the right type *) val length : 'a t -> int (** Number of bindings *) diff --git a/src/lwt/lwt_pipe.mli b/src/lwt/lwt_pipe.mli index a24debae..87ba7ecc 100644 --- a/src/lwt/lwt_pipe.mli +++ b/src/lwt/lwt_pipe.mli @@ -28,7 +28,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Stream processing using: - - Pipe: a possibly buffered channel through which readers and writer communicate + - Pipe: a possibly buffered channel that can act as a reader or as a writer - Reader: accepts values, produces effects - Writer: yield values @@ -115,6 +115,8 @@ val write_list : ('a, [>`w]) t -> 'a list -> unit Lwt.t val write_error : (_, [>`w]) t -> string -> unit Lwt.t (** @raise Pipe.Closed if the writer is closed *) +(** {2 Write-only Interface and Combinators} *) + module Writer : sig type 'a t = ('a, [`w]) pipe @@ -131,6 +133,8 @@ module Writer : sig @raise Invalid_argument if the list is empty *) end +(** {2 Read-only Interface and Combinators} *) + module Reader : sig type 'a t = ('a, [`r]) pipe