Skip to content

Commit 4e2f922

Browse files
committed
doc: add details to CCResult.of_opt
1 parent 43f82d7 commit 4e2f922

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/core/CCResult.mli

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ val to_opt : ('a, _) t -> 'a option
263263
(** Convert a result to an option. *)
264264

265265
val of_opt : 'a option -> ('a, string) t
266-
(** Convert an option to a result. *)
266+
(** [of_opt opt] converts [Some v] to [Ok v] and [None] to [Error "of_opt"].*)
267267

268268
val to_iter : ('a, _) t -> 'a iter
269269
(** @since 2.8 *)

0 commit comments

Comments
 (0)