Skip to content

Commit 584eb69

Browse files
authored
Add entry for Result module docs (#20053)
fixes #17369
1 parent 34b0a1b commit 584eb69

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/fsharp/language-reference/results.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Results
33
description: Learn how to use the F# 'Result' type to help you write error-tolerant code.
4-
ms.date: 04/24/2017
4+
ms.date: 08/13/2020
55
---
66
# Results
77

8-
Starting with F# 4.1, there is a `Result<'T,'TFailure>` type which you can use for writing error-tolerant code which can be composed.
8+
The `Result<'T,'TFailure>` type lets you write error-tolerant code that can be composed.
99

1010
## Syntax
1111

@@ -21,7 +21,9 @@ type Result<'T,'TError> =
2121

2222
## Remarks
2323

24-
Note that the result type is a [struct discriminated union](discriminated-unions.md#struct-discriminated-unions), which is another feature introduced in F# 4.1. Structural equality semantics apply here.
24+
See the [`Result`](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-resultmodule.html) module for the built-in combinators for the `Result`. type.
25+
26+
Note that the result type is a [struct discriminated union](discriminated-unions.md#struct-discriminated-unions). Structural equality semantics apply here.
2527

2628
The `Result` type is typically used in monadic error-handling, which is often referred to as [Railway-oriented Programming](https://swlaschin.gitbooks.io/fsharpforfunandprofit/content/posts/recipe-part2.html) within the F# community. The following trivial example demonstrates this approach.
2729

0 commit comments

Comments
 (0)