From b9ce69dd3589a7def95632878533bac0e525459c Mon Sep 17 00:00:00 2001 From: Thomas Leonard Date: Mon, 17 Jan 2022 15:08:38 +0000 Subject: [PATCH] Fix minor documentation errors --- doc/rationale.md | 2 +- lib_ctf/unix/ctf_unix.mli | 2 +- lib_eio_linux/eio_linux.mli | 2 +- lib_eio_luv/eio_luv.mli | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/rationale.md b/doc/rationale.md index 3f7554776..19e5d76f1 100644 --- a/doc/rationale.md +++ b/doc/rationale.md @@ -99,7 +99,7 @@ For example: - Some flows are backed by a Unix file descriptor which we may want to extract. The OCaml standard library provides separate `close_in` and `close_out` functions, but cannot handle two-way flows. -Eio instead provides a single `Flow.close` what works with all flows that can be closed. +Eio instead provides a single `Flow.close` that works with all flows that can be closed. Users of Eio can choose how specific to make their code. For example, calling `Eio_main.run` will get you a basic Unix-like environment, diff --git a/lib_ctf/unix/ctf_unix.mli b/lib_ctf/unix/ctf_unix.mli index f689cbac3..2366f3da1 100644 --- a/lib_ctf/unix/ctf_unix.mli +++ b/lib_ctf/unix/ctf_unix.mli @@ -6,4 +6,4 @@ val mmap_buffer : size:int -> string -> Ctf.log_buffer val with_tracing : ?size:int -> string -> (unit -> 'a) -> 'a (** [with_tracing path fn] is a convenience function that uses {!mmap_buffer} to create a log buffer, - calls {!Control.start} to start recording, runs [fn], and then stops recording. *) + calls {!Ctf.Control.start} to start recording, runs [fn], and then stops recording. *) diff --git a/lib_eio_linux/eio_linux.mli b/lib_eio_linux/eio_linux.mli index 9979d4735..2a734d582 100644 --- a/lib_eio_linux/eio_linux.mli +++ b/lib_eio_linux/eio_linux.mli @@ -23,7 +23,7 @@ module FD : sig type t val is_open : t -> bool - (** [is_open t] is [true] if {!close t} hasn't been called yet. *) + (** [is_open t] is [true] if {!close} hasn't been called yet. *) val close : t -> unit (** [close t] closes [t]. diff --git a/lib_eio_luv/eio_luv.mli b/lib_eio_luv/eio_luv.mli index dcbf5ec23..a6da3f61b 100644 --- a/lib_eio_luv/eio_luv.mli +++ b/lib_eio_luv/eio_luv.mli @@ -40,7 +40,7 @@ module File : sig type t val is_open : t -> bool - (** [is_open t] is [true] if {!close t} hasn't been called yet. *) + (** [is_open t] is [true] if {!close} hasn't been called yet. *) val close : t -> unit (** [close t] closes [t]. @@ -80,7 +80,7 @@ module Handle : sig type 'a t val is_open : 'a t -> bool - (** [is_open t] is [true] if {!close t} hasn't been called yet. *) + (** [is_open t] is [true] if {!close} hasn't been called yet. *) val close : 'a t -> unit (** [close t] closes [t].