Skip to content

Commit 3d324d1

Browse files
wallymathieuwallymathieu
committed
Added comments and change 'Success' to 'Ok' in Result type
1 parent 12734f7 commit 3d324d1

File tree

3 files changed

+65
-63
lines changed

3 files changed

+65
-63
lines changed

‎src/fsharp/FSharp.Core.Unittests/SurfaceArea.net40.fs‎

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -2157,69 +2157,69 @@ Microsoft.FSharp.Core.FSharpRef`1[T]: T get_contents()
21572157
Microsoft.FSharp.Core.FSharpRef`1[T]: Void .ctor(T)
21582158
Microsoft.FSharp.Core.FSharpRef`1[T]: Void set_Value(T)
21592159
Microsoft.FSharp.Core.FSharpRef`1[T]: Void set_contents(T)
2160-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean Equals(Microsoft.FSharp.Core.FSharpResult`2[T1,T2])
2161-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean Equals(System.Object)
2162-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean Equals(System.Object, System.Collections.IEqualityComparer)
2163-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean IsError
2164-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean IsSuccess
2165-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean get_IsError()
2166-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Boolean get_IsSuccess()
2167-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 CompareTo(Microsoft.FSharp.Core.FSharpResult`2[T1,T2])
2168-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 CompareTo(System.Object)
2169-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 CompareTo(System.Object, System.Collections.IComparer)
2170-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 GetHashCode()
2171-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 GetHashCode(System.Collections.IEqualityComparer)
2172-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 Tag
2173-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: Int32 get_Tag()
2174-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: System.String ToString()
2175-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: System.Type GetType()
2176-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: T2 Item
2177-
Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]: T2 get_Item()
2178-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean Equals(Microsoft.FSharp.Core.FSharpResult`2[T1,T2])
2179-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean Equals(System.Object)
2180-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean Equals(System.Object, System.Collections.IEqualityComparer)
2181-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean IsError
2182-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean IsSuccess
2183-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean get_IsError()
2184-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Boolean get_IsSuccess()
2185-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 CompareTo(Microsoft.FSharp.Core.FSharpResult`2[T1,T2])
2186-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 CompareTo(System.Object)
2187-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 CompareTo(System.Object, System.Collections.IComparer)
2188-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 GetHashCode()
2189-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 GetHashCode(System.Collections.IEqualityComparer)
2190-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 Tag
2191-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: Int32 get_Tag()
2192-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: System.String ToString()
2193-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: System.Type GetType()
2194-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: T1 Item
2195-
Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]: T1 get_Item()
2160+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean Equals(Microsoft.FSharp.Core.FSharpResult`2[TOk,TError])
2161+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean Equals(System.Object)
2162+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean Equals(System.Object, System.Collections.IEqualityComparer)
2163+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean IsError
2164+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean IsOk
2165+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean get_IsError()
2166+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Boolean get_IsOk()
2167+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 CompareTo(Microsoft.FSharp.Core.FSharpResult`2[TOk,TError])
2168+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 CompareTo(System.Object)
2169+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 CompareTo(System.Object, System.Collections.IComparer)
2170+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 GetHashCode()
2171+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 GetHashCode(System.Collections.IEqualityComparer)
2172+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 Tag
2173+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: Int32 get_Tag()
2174+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: System.String ToString()
2175+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: System.Type GetType()
2176+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: TError Item
2177+
Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]: TError get_Item()
2178+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean Equals(Microsoft.FSharp.Core.FSharpResult`2[TOk,TError])
2179+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean Equals(System.Object)
2180+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean Equals(System.Object, System.Collections.IEqualityComparer)
2181+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean IsError
2182+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean IsOk
2183+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean get_IsError()
2184+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Boolean get_IsOk()
2185+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 CompareTo(Microsoft.FSharp.Core.FSharpResult`2[TOk,TError])
2186+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 CompareTo(System.Object)
2187+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 CompareTo(System.Object, System.Collections.IComparer)
2188+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 GetHashCode()
2189+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 GetHashCode(System.Collections.IEqualityComparer)
2190+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 Tag
2191+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: Int32 get_Tag()
2192+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: System.String ToString()
2193+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: System.Type GetType()
2194+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: TOk Item
2195+
Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]: TOk get_Item()
21962196
Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]: Boolean Equals(System.Object)
21972197
Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]: Int32 Error
21982198
Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]: Int32 GetHashCode()
21992199
Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]: Int32 Success
22002200
Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]: System.String ToString()
22012201
Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]: System.Type GetType()
2202-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean Equals(Microsoft.FSharp.Core.FSharpResult`2[T1,T2])
2203-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean Equals(System.Object)
2204-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean Equals(System.Object, System.Collections.IEqualityComparer)
2205-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean IsError
2206-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean IsSuccess
2207-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean get_IsError()
2208-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Boolean get_IsSuccess()
2209-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 CompareTo(Microsoft.FSharp.Core.FSharpResult`2[T1,T2])
2210-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 CompareTo(System.Object)
2211-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 CompareTo(System.Object, System.Collections.IComparer)
2212-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 GetHashCode()
2213-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 GetHashCode(System.Collections.IEqualityComparer)
2214-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 Tag
2215-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Int32 get_Tag()
2216-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Microsoft.FSharp.Core.FSharpResult`2+Error[T1,T2]
2217-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Microsoft.FSharp.Core.FSharpResult`2+Success[T1,T2]
2218-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]
2219-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Microsoft.FSharp.Core.FSharpResult`2[T1,T2] NewError(T2)
2220-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: Microsoft.FSharp.Core.FSharpResult`2[T1,T2] NewSuccess(T1)
2221-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: System.String ToString()
2222-
Microsoft.FSharp.Core.FSharpResult`2[T1,T2]: System.Type GetType()
2202+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean Equals(Microsoft.FSharp.Core.FSharpResult`2[TOk,TError])
2203+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean Equals(System.Object)
2204+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean Equals(System.Object, System.Collections.IEqualityComparer)
2205+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean IsError
2206+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean IsSuccess
2207+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean get_IsError()
2208+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Boolean get_IsSuccess()
2209+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 CompareTo(Microsoft.FSharp.Core.FSharpResult`2[TOk,TError])
2210+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 CompareTo(System.Object)
2211+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 CompareTo(System.Object, System.Collections.IComparer)
2212+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 GetHashCode()
2213+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 GetHashCode(System.Collections.IEqualityComparer)
2214+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 Tag
2215+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Int32 get_Tag()
2216+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Microsoft.FSharp.Core.FSharpResult`2+Error[TOk,TError]
2217+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Microsoft.FSharp.Core.FSharpResult`2+Success[TOk,TError]
2218+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Microsoft.FSharp.Core.FSharpResult`2+Tags[T1,T2]
2219+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Microsoft.FSharp.Core.FSharpResult`2[TOk,TError] NewError(T2)
2220+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: Microsoft.FSharp.Core.FSharpResult`2[TOk,TError] NewSuccess(T1)
2221+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: System.String ToString()
2222+
Microsoft.FSharp.Core.FSharpResult`2[TOk,TError]: System.Type GetType()
22232223
Microsoft.FSharp.Core.FSharpTypeFunc: Boolean Equals(System.Object)
22242224
Microsoft.FSharp.Core.FSharpTypeFunc: Int32 GetHashCode()
22252225
Microsoft.FSharp.Core.FSharpTypeFunc: System.Object Specialize[T]()

‎src/fsharp/FSharp.Core/prim-types.fs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4737,9 +4737,9 @@ namespace Microsoft.FSharp.Core
47374737

47384738
[<StructuralEquality; StructuralComparison>]
47394739
[<CompiledName("FSharpResult`2")>]
4740-
type Result<'T1,'T2> =
4741-
| Success of 'T1
4742-
| Error of 'T2
4740+
type Result<'TOk,'TError> =
4741+
| Ok of 'TOk
4742+
| Error of 'TError
47434743

47444744

47454745
//============================================================================

‎src/fsharp/FSharp.Core/prim-types.fsi‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1775,9 +1775,11 @@ namespace Microsoft.FSharp.Core
17751775
/// <summary>Helper type for error handling without exceptions.</summary>
17761776
[<StructuralEquality; StructuralComparison>]
17771777
[<CompiledName("FSharpResult`2")>]
1778-
type Result<'T1,'T2> =
1779-
| Success of 'T1
1780-
| Error of 'T2
1778+
type Result<'TOk,'TError> =
1779+
/// Represents an OK or a Successful result. The code succeeded with a value of 'TOk.
1780+
| Ok of 'TOk
1781+
/// Represents an Error or a Failure. The code failed with a value of 'TError representing what went wrong.
1782+
| Error of 'TError
17811783

17821784
namespace Microsoft.FSharp.Collections
17831785

0 commit comments

Comments
 (0)