Skip to content

Commit

Permalink
Fix minor documentation errors
Browse files Browse the repository at this point in the history
  • Loading branch information
talex5 committed Jan 17, 2022
1 parent fd15d1b commit b9ce69d
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/rationale.md
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion lib_ctf/unix/ctf_unix.mli
Expand Up @@ -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. *)
2 changes: 1 addition & 1 deletion lib_eio_linux/eio_linux.mli
Expand Up @@ -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].
Expand Down
4 changes: 2 additions & 2 deletions lib_eio_luv/eio_luv.mli
Expand Up @@ -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].
Expand Down Expand Up @@ -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].
Expand Down

0 comments on commit b9ce69d

Please sign in to comment.