Skip to content

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hannesm committed Feb 24, 2019
1 parent c4720f6 commit f56227e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/mirage_kv.mli
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@
{e %%VERSION%% } *)

(** {1 Mirage_kv} *)
(** {2 Mirage_kv} *)

(** MirageOS key-value stores are nested dictionaries, associating
structured {{!Key}keys} to either dictionaries or values. *)

module Key: sig

(** {1 Structured keys} *)
(** {2 Structured keys} *)

type t
(** The type for structured keys. *)
Expand Down Expand Up @@ -100,7 +100,7 @@ val pp_error: error Fmt.t

module type RO = sig

(** {1 Read-only key-value stores} *)
(** {2 Read-only key-value stores} *)

type nonrec error = private [> error]
(** The type for errors. *)
Expand Down Expand Up @@ -173,7 +173,7 @@ val pp_write_error: write_error Fmt.t

module type RW = sig

(** {1 Read-write Stores} *)
(** {2 Read-write Stores} *)

(** There is a trade-off between durability and performance. If you
want performance, use the {!batch} operation with a chain of sets
Expand Down Expand Up @@ -215,8 +215,8 @@ module type RW = sig
Batch applications can fail to apply if other operations are
happening concurrently. In case of failure, [f] will run again
with the most recent version of [t]. The result is [Error
`Too_many_retries] if [f] is run for more then [retries] attemps
with the most recent version of [t]. The result is
[Error `Too_many_retries] if [f] is run for more then [retries] attemps
(default is [13]). *)

end

0 comments on commit f56227e

Please sign in to comment.