Skip to content

Commit 5dd772d

Browse files
authored
Merge pull request #39 from hannesm/improve-list-docstring
adjust docstring for list, fixes #38
2 parents 297015e + f3e1cc5 commit 5dd772d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/mirage_kv.mli

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ module type RO = sig
147147

148148
val list: t -> key -> ((key * [`Value | `Dictionary]) list, error) result Lwt.t
149149
(** [list t k] is the list of entries and their types in the
150-
dictionary referenced by [k] in [t].
150+
dictionary referenced by [k] in [t]. The returned keys are all absolute
151+
(i.e. [Key.add k entry]).
151152
152153
The result is [Error (`Dictionary_expected k)] if [k] refers to a
153154
value in [t]. *)

0 commit comments

Comments
 (0)