aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib
diff options
context:
space:
mode:
authorGravatar Hugo Herbelin <Hugo.Herbelin@inria.fr>2017-05-05 17:41:00 +0200
committerGravatar Hugo Herbelin <Hugo.Herbelin@inria.fr>2017-05-05 17:49:42 +0200
commitf24d8876837e2f9121064f496d89803f60ec2c71 (patch)
tree7af19f802e74fd224dd6a31eb4bd73d7568824b0 /lib
parent3f4c29f8258d627c7dbacbf1157825d96b146a6d (diff)
Documenting Option.List.find.
Diffstat (limited to 'lib')
-rw-r--r--lib/option.mli3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/option.mli b/lib/option.mli
index a336c895c..f06ad9f1d 100644
--- a/lib/option.mli
+++ b/lib/option.mli
@@ -122,6 +122,9 @@ module List : sig
[Some y] (in the same order). *)
val flatten : 'a option list -> 'a list
+ (** [List.find f l] is the first [f a] different from [None],
+ scrolling through elements [a] of [l] in left-to-right order;
+ it is [None] if no such element exists. *)
val find : ('a -> 'b option) -> 'a list -> 'b option
(** [List.map f [a1;...;an]] is the list [Some [b1;...;bn]] if