About Option doc (#273)

* XML doc for Option.sequenceResult * doc for Option.traverseResult and Option.sequenceResult moved under Option * minor doc changes to get the code referenced by the traverseResult tutorial working
demystifyfp · Jul 18, 2024 · fd9460f · fd9460f
1 parent d1ca343
commit fd9460f
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 6 deletions.
diff --git a/gitbook/SUMMARY.md b/gitbook/SUMMARY.md
@@ -36,7 +36,9 @@
     * [map](option/map.md)
     * [map2](option/map2.md)
     * [map3](option/map3.md)
+    * [sequenceResult](option/sequenceResult.md)
     * [tee Functions](option/teeFunctions.md)
+    * [traverseResult](option/traverseResult.md)
     * [zip](option/zip.md)
     * Lists
         * [traverseOptionM](option/traverseOptionM.md)
@@ -62,9 +64,6 @@
     * [Operators](resultOption/operators.md)
     * [zip](resultOption/zip.md)
     * [zipError](resultOption/zipError.md)
-    * Lists
-      * [traverseResult](resultOption/traverseResult.md)
-      * [sequenceResult](resultOption/sequenceResult.md)
     * Transforms
       * [ofChoice](resultOption/ofChoice.md)
       * [ofOption](resultOption/ofOption.md)

diff --git a/gitbook/resultOption/sequenceResult.md → gitbook/option/sequenceResult.md b/gitbook/resultOption/sequenceResult.md → gitbook/option/sequenceResult.md
diff --git a/gitbook/resultOption/traverseResult.md → gitbook/option/traverseResult.md b/gitbook/resultOption/traverseResult.md → gitbook/option/traverseResult.md
diff --git a/gitbook/result/map2.md b/gitbook/result/map2.md
@@ -26,7 +26,7 @@ And an another function that converts a string to an integer:
 
 ```fsharp
 // string -> Result<int, string>
-let tryParseInt str =
+let tryParseInt (str: string) =
   match System.Int32.TryParse str with
   | true, x -> Ok x
   | false, _ ->

diff --git a/gitbook/result/map3.md b/gitbook/result/map3.md
@@ -26,7 +26,7 @@ And an another function that converts a string to an integer:
 
 ```fsharp
 // string -> Result<int, string>
-let tryParseInt str =
+let tryParseInt (str: string) =
   match System.Int32.TryParse str with
   | true, x -> Ok x
   | false, _ ->
@@ -66,7 +66,7 @@ type Tweet = private Tweet of string with
       Error "Tweet shouldn't be empty"
     elif tweet.Length > 280 then
       Error "Tweet shouldn't contain more than 280 characters"
-    else Ok (Tweet x)
+    else Ok (Tweet tweet)
 ```
 
 #### CreatePostRequest

diff --git a/src/FsToolkit.ErrorHandling/Option.fs b/src/FsToolkit.ErrorHandling/Option.fs
@@ -128,6 +128,11 @@ module Option =
             binder v
             |> Result.map Some
 
+    /// <summary>
+    /// Flips around the option and result structures of an option that contains a result.
+    /// </summary>
+    /// <param name="opt">The option containing a result.</param>
+    /// <returns>A result containing an option.</returns>
     let inline sequenceResult (opt: Result<'ok, 'error> option) : Result<'ok option, 'error> =
         traverseResult id opt