Updated documentation and added unit tests

Author: 1eyewonder

gitbook/bindMappings.md

@@ -30,7 +30,7 @@ Each CE can bind to itself so we don't list that here to reduce clutter
 | JobResultOption           |                                                                                                                                            |
 | Option                    | ValueOption, nullable object                                                                                                               |
 | Result                    | Choice                                                                                                                                     |
-| ResultOption              |                                                                                                                                            |
+| ResultOption              | Result, Choice, Option                                                                                                                     |
 | Task                      |                                                                                                                                            |
 | TaskOption                | ValueTaskOption, AsyncOption, PlyOption, Async, Task, ValueTask, Option                                                                    |
 | TaskResult                | AsyncResult, PlyResult, TaskResult, ValueTaskResult, Result, Choice, Ply, Async, Task, ValueTask                                           |

gitbook/resultOption/apply.md

@@ -1,4 +1,4 @@
-## ResultOption.apply
+# ResultOption.apply
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -10,3 +10,40 @@ Result<('a -> 'b) option, 'c> -> Result<'a option, 'c>
 ```
 
 ## Examples
+
+Take the following function for example
+
+```fsharp
+// string -> int
+let characterCount (s: string) = s.Length
+```
+
+### Example 1
+
+```fsharp
+let result =
+    Ok(Some "foo") // Result<string option, 'error>
+    |> ResultOption.apply (Ok(Some characterCount)) // Result<int option, 'error>
+
+// Ok (Some 3)
+```
+
+### Example 2
+
+```fsharp
+let result =
+    Ok None // Result<string option, 'error>
+    |> ResultOption.apply (Ok(Some characterCount)) // Result<int option, 'error>
+
+// Ok None
+```
+
+### Example 3
+
+```fsharp
+let result =
+    Error "bad things happened" // Result<string option, string>
+    |> ResultOption.apply (Ok(Some characterCount)) // Result<int option, string>
+
+// Error "bad things happened"
+```

gitbook/resultOption/bind.md

@@ -1,4 +1,4 @@
-## ResultOption.bind
+# ResultOption.bind
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -9,4 +9,54 @@ Function Signature:
   -> Result<'b option, 'c>
 ```
 
-## Examples
+## Examples
+
+Take the following function for example
+
+```fsharp
+// string -> Result<int option, string>
+let tryParseInt (s: string) =
+    match Int32.TryParse(s) with
+    | true, i -> Ok(Some i)
+    | false, _ -> Error "Could not parse string as int"
+```
+
+### Example 1
+
+```fsharp
+let result =
+    Ok(Some "123") // Result<string option, 'error>
+    |> ResultOption.bind tryParseInt // Result<int option, 'error>
+
+// Ok (Some 123)
+```
+
+### Example 2
+
+```fsharp
+let result =
+    Ok None // Result<string option, 'error>
+    |> ResultOption.bind tryParseInt // Result<int option, 'error>
+
+// Ok None
+```
+
+### Example 3
+
+```fsharp
+let result =
+    Ok(Some "bad things happened") // Result<string option, string>
+    |> ResultOption.bind tryParseInt // Result<int option, string>
+
+// Error "Could not parse string as int"
+```
+
+### Example 4
+
+```fsharp
+let result =
+    Error "bad things happened" // Result<string option, string>
+    |> ResultOption.bind tryParseInt // Result<int option, string>
+
+// Error "bad things happened"
+```

gitbook/resultOption/ce.md

@@ -1,4 +1,4 @@
-## Result Computation Expression
+# Result Computation Expression
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -15,10 +15,25 @@ let addResult : Result<int option, string> = resultOption {
   let! z = Ok (Some 2)
   return add x y z
 }
+// Ok (Some 42)
 ```
 
 ### Example 2
 
+```fsharp
+let add x y z = x + y + z
+
+let addResult : Result<int option, string> = resultOption {
+  let! x = Ok (Some 30)
+  and! y = Error "Oops 1"
+  and! z = Error "Oops 2"
+  return add x y z
+}
+// Error "Oops 1"
+```
+
+### Example 3
+
 The [ResultOption.map2 example](../resultOption/map2.md#example-2) can be written using the `resultOption` computation expression as below
 
 ```fsharp
@@ -41,4 +56,4 @@ let toCreatePostRequest (dto : CreatePostRequestDto) =
 
   // Result<CreatePostRequest, string>
   Result.map2 createPostRequest2 tweetR locationR
-```
+```

gitbook/resultOption/ignore.md

@@ -1,4 +1,4 @@
-## ResultOption.ignore
+# ResultOption.ignore
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -24,4 +24,4 @@ We can call this with the `do!` syntax inside a computation expression using `Re
 let deletePost = resultOption {
   do! deletePostIfExists deletePostRequest |> ResultOption.ignore
 }
-```
+```

gitbook/resultOption/map.md

@@ -1,4 +1,4 @@
-## ResultOption.map
+# ResultOption.map
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -10,19 +10,42 @@ Function Signature:
 
 `ResultOption.map` is the same as `Result.map Option.map`.
 
-### Example 1
+## Examples
+
+Take the following functions for example
+
+```fsharp
+// string -> int
+let remainingCharacters (string: prompt) =
+    280 - prompt.Length
+```
 
-Given the following functions:
+### Example 1
 
 ```fsharp
-getTweet : PostId -> Result<Tweet option, _>
-remainingCharacters : Tweet -> int
+let result =
+    Ok(Some "foo") // Result<string option, 'error>
+    |> ResultOption.map remainingCharacters // Result<int option, 'error>
+
+// Ok (Some 277)
 ```
 
-You can get the number of remaining characters as below:
+### Example 2
 
 ```fsharp
-getTweetByPostId somePostId
-|> ResultOption.map remainingCharacters
+let result =
+    Ok None // Result<string option, 'error>
+    |> ResultOption.map remainingCharacters // Result<int option, 'error>
+
+// Ok None
 ```
 
+### Example 3
+
+```fsharp
+let result =
+    Error "bad things happened" // Result<string option, string>
+    |> ResultOption.map remainingCharacters // Result<int option, string>
+
+// Error "bad things happened"
+```

gitbook/resultOption/map2.md

@@ -1,4 +1,4 @@
-## ResultOption.map2
+# ResultOption.map2
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -11,6 +11,8 @@ Function Signature:
   -> Result<'c option, 'd>
 ```
 
+## Examples
+
 ### Example 1
 
 Given the following function:
@@ -49,7 +51,6 @@ type CreatePostRequestDto = {
 
 We can then create a function transforming a `CreatePostRequestDto` to a `CreatePostRequest`, using `Option.traverseResult`, `ResultOption.map2`, and `Result.map2`:
 
-
 ```fsharp
 // CreatePostRequestDto -> Result<CreatePostRequest, string>
 let toCreatePostRequest (dto : CreatePostRequestDto) = 

gitbook/resultOption/map3.md

@@ -1,4 +1,4 @@
-## ResultOption.map3
+# ResultOption.map3
 
 Namespace: `FsToolkit.ErrorHandling`
 
@@ -12,6 +12,8 @@ Function Signature:
   -> Result<'d option, 'e>
 ```
 
+## Examples
+
 ### Example 1
 
 Given the following function:
@@ -26,4 +28,3 @@ Then using `ResultOption.map3`, we can do the following:
 ResultOption.map3 add (Ok (Some 30)) (Ok (Some 10)) (Ok (Some 2)) 
 // Ok (Some 42)
 ```
-

gitbook/resultOption/operators.md

@@ -1,12 +1,12 @@
-## ResultOption Infix Operators
+# ResultOption Infix Operators
 
 Namespace: `FsToolkit.ErrorHandling.Operator.ResultOption`
 
 FsToolkit.ErrorHandling provides the standard infix operators for the `map` (`<!>`), `apply` (`<*>`), and `bind` (`>>=`) functions of the `Result<Option<_>,_>` type.
 
 In addition to these, it also offers an another infix operator `<*^>` for usage with normal `Result` values (without an inner `Option`). It has the following function signature:
 
-```
+``` fsharp
 Result<('a -> 'b) option, 'c> -> Result<'a, 'c> 
   -> Result<'b option, 'c>
 ```

gitbook/resultOption/zip.md

@@ -0,0 +1,39 @@
+# ResultOption.zip
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Function Signature:
+
+```fsharp
+Result<'leftOk option, 'error> -> Result<'rightOk option, 'error> -> Result<('leftOk * 'rightOk) option, 'error>
+```
+
+## Examples
+
+### Example 1
+
+```fsharp
+let result = ResultOption.zip (Ok(Some 1)) (Ok(Some 2))
+// Ok (Some(1, 2))
+```
+
+### Example 2
+
+```fsharp
+let result = ResultOption.zip (Ok(Some 1)) (Ok None)
+// Ok None
+```
+
+### Example 3
+
+```fsharp
+let result = ResultOption.zip (Ok(Some 1)) (Error "Bad")
+// Error "Bad"
+```
+
+### Example 4
+
+```fsharp
+let result = ResultOption.zip (Error "Bad1") (Error "Bad2")
+// Error "Bad1"
+```