From 4e2f9220ddbee6ade436eba8399a3030124a0088 Mon Sep 17 00:00:00 2001
From: Fardale <fardale+git@crans.org>
Date: Fri, 5 Aug 2022 21:37:43 +0200
Subject: [PATCH] doc: add details to CCResult.of_opt

---
 src/core/CCResult.mli | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/core/CCResult.mli b/src/core/CCResult.mli
index 1a7b2b5e..e71eb625 100644
--- a/src/core/CCResult.mli
+++ b/src/core/CCResult.mli
@@ -263,7 +263,7 @@ val to_opt : ('a, _) t -> 'a option
 (** Convert a result to an option. *)
 
 val of_opt : 'a option -> ('a, string) t
-(** Convert an option to a result. *)
+(** [of_opt opt] converts [Some v] to [Ok v] and [None] to [Error "of_opt"].*)
 
 val to_iter : ('a, _) t -> 'a iter
 (** @since 2.8 *)