start adding docs

demystifyfp · Jan 11, 2025 · 2b8c474 · 2b8c474
1 parent 4c12451
commit 2b8c474
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/gitbook/result/requireFunctions.md b/gitbook/result/requireFunctions.md
@@ -64,6 +64,38 @@ let result : Result<unit, string> =
 // Error "Value must be false"
 ```
 
+## requireSome
+
+Converts an Option to a Result, using the given function to supply an error if None.
+
+### Function Signature
+
+```fsharp
+'a -> 'b option -> Result<'b, 'a>
+```
+
+### Examples
+
+#### Example 1
+
+```fsharp
+let result : Result<unit, string> =
+    Some 1
+    |> Result.requireSome "Value must be Some"
+    
+// Ok ()
+```
+
+#### Example 2
+
+```fsharp
+let result : Result<unit, string> =
+    None
+    |> Result.requireSome "Value must be Some"
+    
+// Error "Value must be Some"
+```
+
 ## requireSomeWith
 
 Converts an Option to a Result, using the given function to supply an error if None.

diff --git a/src/FsToolkit.ErrorHandling/Result.fs b/src/FsToolkit.ErrorHandling/Result.fs
@@ -312,8 +312,8 @@ module Result =
     ///
     /// Documentation is found here: <href>https://demystifyfp.gitbook.io/fstoolkit-errorhandling/fstoolkit.errorhandling/result/others#requireSomeWith</href>
     /// </summary>
-    /// <param name="ifErrorThunk">The function to evaluate if the result is <c>Error</c>.</param>
-    /// <param name="option">The input result.</param>
+    /// <param name="ifErrorThunk">The function to evaluate if the result is <c>None</c>.</param>
+    /// <param name="option">The input option.</param>
     /// <returns>The contained value if <c>Some</c>, otherwise the result of evaluating <paramref name="ifErrorThunk"/>.</returns>
     let inline requireSomeWith
         (ifErrorThunk: unit -> 'error)