Rename returnError to error; add documentation

Author: tw0po1nt

gitbook/SUMMARY.md

@@ -87,7 +87,7 @@
     * [bind](asyncResult/bind.md)
     * [check](asyncResult/check.md)
     * [Computation Expression](asyncResult/ce.md)
-    * [error](pr.md)
+    * [error](asyncResult/error.md)
     * [foldResult](asyncResult/foldResult.md)
     * [ignore](asyncResult/ignore.md)
     * [map](asyncResult/map.md)
@@ -176,7 +176,7 @@
     * [mapError](taskResult/mapError.md)
     * [Operators](taskResult/operators.md)
     * [Other Functions](taskResult/others.md)
-    * [returnError](pr.md)
+    * [error](taskResult/error.md)
     * [zip](pr.md)
     * [zipError](pr.md)
     * Lists
@@ -202,14 +202,13 @@
   * [Validation](validation/index.md)
     * [apply](validation/apply.md)
     * [Computation Expression](validation/ce.md)
-    * [error](pr.md)
+    * [error](validation/error.md)
     * [map](pr.md)
     * [map2](validation/map2.md)
     * [map3](validation/map3.md)
     * [mapError](pr.md)
     * [mapErrors](pr.md)
     * [Operators](validation/operators.md)
-    * [returnError](pr.md)
     * [zip](pr.md)
     * Transforms
       * [ofChoice](validation/ofChoice.md)
@@ -218,14 +217,13 @@
   * [AsyncValidation](asyncValidation/index.md)
     * [apply](asyncValidation/apply.md)
     * [Computation Expression](asyncValidation/ce.md)
-    * [error](pr.md)
+    * [error](asyncValidation/error.md)
     * [map](pr.md)
     * [map2](asyncValidation/map2.md)
     * [map3](asyncValidation/map3.md)
     * [mapError](pr.md)
     * [mapErrors](pr.md)
     * [Operators](asyncValidation/operators.md)
-    * [returnError](pr.md)
     * [zip](pr.md)
     * Transforms
       * [ofChoice](asyncValidation/ofChoice.md)
@@ -251,7 +249,7 @@
     * [apply](cancellableTaskValidation/apply.md)
     * [bind](pr.md)
     * [Computation Expression](cancellableTaskValidation/ce.md)
-    * [error](pr.md)
+    * [error](cancellableTaskValidation/error.md)
     * [getCancellationToken](pr.md)
     * [map](pr.md)
     * [map2](cancellableTaskValidation/map2.md)
@@ -285,7 +283,7 @@
     * [bind](jobResult/bind.md)
     * [catch](pr.md)
     * [Computation Expression](jobResult/ce.md)
-    * [error](pr.md)
+    * [error](jobResult/error.md)
     * [fromTask](pr.md)
     * [fromUnitTask](pr.md)
     * [ignore](jobResult/ignore.md)
@@ -295,7 +293,6 @@
     * [mapError](jobResult/mapError.md)
     * [Operators](jobResult/operators.md)
     * [Other Functions](jobResult/others.md)
-    * [returnError](pr.md)
     * [zip](pr.md)
     * [zipError](pr.md)
     * Lists

gitbook/asyncResult/error.md

@@ -0,0 +1,22 @@
+## AsyncResult.error
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Lift an 'error value into an Async<Result<'ok, 'error>>
+
+## Function Signature:
+
+```fsharp
+'error -> Async<Result<'ok, 'error>>
+```
+
+## Examples
+
+### Example 1
+
+
+```fsharp
+let result : Async<Result<int, string>> =
+  AsyncResult.error "Something bad happened"
+```
+

gitbook/asyncValidation/error.md

@@ -0,0 +1,22 @@
+## CancellableTaskValidation
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Lift an 'error value into an CancellableTaskValidation<'ok, 'error>
+
+## Function Signature:
+
+```fsharp
+'error -> CancellableTaskValidation<'ok, 'error>
+```
+
+## Examples
+
+### Example 1
+
+
+```fsharp
+let result : CancellableTaskValidation<int, string> =
+  CancellableTaskValidation.error "Something bad happened"
+```
+

gitbook/cancellableTaskValidation/error.md

@@ -0,0 +1,22 @@
+## CancellableTaskValidation.error
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Lift an 'error value into an Async<Validation<'ok, 'error>>
+
+## Function Signature:
+
+```fsharp
+'error -> Async<Validation<'ok, 'error>>
+```
+
+## Examples
+
+### Example 1
+
+
+```fsharp
+let result : Async<Validation<int, string>> =
+  AsyncValidation.error "Something bad happened"
+```
+

gitbook/jobResult/error.md

@@ -0,0 +1,22 @@
+## JobResult.error
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Lift an 'error value into an Job<Result<'ok, 'error>>
+
+## Function Signature:
+
+```fsharp
+'error -> Job<Result<'ok, 'error>>
+```
+
+## Examples
+
+### Example 1
+
+
+```fsharp
+let result : Job<Result<int, string>> =
+  JobResult.error "Something bad happened"
+```
+

gitbook/taskResult/error.md

@@ -0,0 +1,22 @@
+## TaskResult.error
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Lift an 'error value into an Task<Result<'ok, 'error>>
+
+## Function Signature:
+
+```fsharp
+'error -> Task<Result<'ok, 'error>>
+```
+
+## Examples
+
+### Example 1
+
+
+```fsharp
+let result : Task<Result<int, string>> =
+  TaskResult.error "Something bad happened"
+```
+

gitbook/validation/error.md

@@ -0,0 +1,22 @@
+## Validation.error
+
+Namespace: `FsToolkit.ErrorHandling`
+
+Lift an 'error value into an Validation<'ok, 'error>
+
+## Function Signature:
+
+```fsharp
+'error -> Validation<'ok, 'error>
+```
+
+## Examples
+
+### Example 1
+
+
+```fsharp
+let result : Validation<int, string> =
+  Validation.error "Something bad happened"
+```
+

src/FsToolkit.ErrorHandling.JobResult/JobResult.fs

@@ -43,12 +43,10 @@ module JobResult =
         Ok x
         |> Job.result
 
-    let inline returnError x =
+    let inline error x =
         Error x
         |> Job.result
 
-    let inline error x = returnError x
-
     let inline map2 ([<InlineIfLambda>] f) xJR yJR = Job.map2 (Result.map2 f) xJR yJR
 
     let inline map3 ([<InlineIfLambda>] f) xJR yJR zJR = Job.map3 (Result.map3 f) xJR yJR zJR

src/FsToolkit.ErrorHandling.JobResult/List.fs

@@ -42,9 +42,9 @@ module List =
                 match s, fR with
                 | Ok ys, Ok y -> return! traverseJobResultA' (JobResult.singleton (y :: ys)) f xs
                 | Error errs, Error e ->
-                    return! traverseJobResultA' (JobResult.returnError (e :: errs)) f xs
-                | Ok _, Error e -> return! traverseJobResultA' (JobResult.returnError [ e ]) f xs
-                | Error e, Ok _ -> return! traverseJobResultA' (JobResult.returnError e) f xs
+                    return! traverseJobResultA' (JobResult.error (e :: errs)) f xs
+                | Ok _, Error e -> return! traverseJobResultA' (JobResult.error [ e ]) f xs
+                | Error e, Ok _ -> return! traverseJobResultA' (JobResult.error e) f xs
             }
 
 

src/FsToolkit.ErrorHandling/Array.fs

@@ -91,13 +91,9 @@ module Array =
                     return! traverseAsyncResultA' (AsyncResult.ok (Array.append [| y |] ys)) f xs
                 | Error errs, Error e ->
                     return!
-                        traverseAsyncResultA'
-                            (AsyncResult.returnError (Array.append [| e |] errs))
-                            f
-                            xs
-                | Ok _, Error e ->
-                    return! traverseAsyncResultA' (AsyncResult.returnError [| e |]) f xs
-                | Error e, Ok _ -> return! traverseAsyncResultA' (AsyncResult.returnError e) f xs
+                        traverseAsyncResultA' (AsyncResult.error (Array.append [| e |] errs)) f xs
+                | Ok _, Error e -> return! traverseAsyncResultA' (AsyncResult.error [| e |]) f xs
+                | Error e, Ok _ -> return! traverseAsyncResultA' (AsyncResult.error e) f xs
             }
 
     let traverseResultA f xs = traverseResultA' (Ok [||]) f xs