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

Author: m-rinaldi

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)

gitbook/resultOption/sequenceResult.md renamed to gitbook/option/sequenceResult.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, _ ->

gitbook/resultOption/traverseResult.md renamed to gitbook/option/traverseResult.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

gitbook/result/map2.md

@@ -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