Added public docstrings to Result custom string convertible protocols.

mcgrady20150318 · Sep 19, 2015 · 8759805 · 8759805
1 parent 8a6ee84
commit 8759805
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Source/Result.swift b/Source/Result.swift
@@ -73,6 +73,8 @@ public enum Result<Value, Error: ErrorType> {
 // MARK: - CustomStringConvertible
 
 extension Result: CustomStringConvertible {
+    /// The textual representation used when written to an output stream, which includes whether the result was a 
+    /// success or failure.
     public var description: String {
         switch self {
         case .Success:
@@ -86,6 +88,8 @@ extension Result: CustomStringConvertible {
 // MARK: - CustomDebugStringConvertible
 
 extension Result: CustomDebugStringConvertible {
+    /// The debug textual representation used when written to an output stream, which includes whether the result was a
+    /// success or failure in addition to the value or error.
     public var debugDescription: String {
         switch self {
         case .Success(let value):