Add doc for Option.maybe.

demystifyfp · Oct 31, 2022 · 4ac6a5b · 4ac6a5b
1 parent 348e4f2
commit 4ac6a5b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/FsToolkit.ErrorHandling/Option.fs b/src/FsToolkit.ErrorHandling/Option.fs
@@ -120,6 +120,15 @@ module Option =
             |> ofNull
         | None -> None
 
+    /// <summary>
+    /// Returns result of running <paramref name="onSome"/> if it is <c>Some</c>, otherwise returns result of running <paramref name="onNone"/>
+    /// </summary>
+    /// <param name="onNone">The function to run if <paramref name="input"/> is <c>None</c></param>
+    /// <param name="onSome">The function to run if <paramref name="input"/> is <c>Some</c></param>
+    /// <param name="input">The input option.</param>
+    /// <returns>
+    /// The result of running <paramref name="onSome"/> if the input is <c>Some</c>, else returns result of running <paramref name="onNone"/>.
+    /// </returns>
     let inline maybe
         ([<InlineIfLambda>] onNone: unit -> 'output)
         ([<InlineIfLambda>] onSome: 'a -> 'output)