Browse Source

Added public docstrings to Result custom string convertible protocols.

Christian Noon 10 years ago
parent
commit
8759805c8c
1 changed files with 4 additions and 0 deletions
  1. 4 0
      Source/Result.swift

+ 4 - 0
Source/Result.swift

@@ -73,6 +73,8 @@ public enum Result<Value, Error: ErrorType> {
 // MARK: - CustomStringConvertible
 // MARK: - CustomStringConvertible
 
 
 extension Result: 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 {
     public var description: String {
         switch self {
         switch self {
         case .Success:
         case .Success:
@@ -86,6 +88,8 @@ extension Result: CustomStringConvertible {
 // MARK: - CustomDebugStringConvertible
 // MARK: - CustomDebugStringConvertible
 
 
 extension Result: 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 {
     public var debugDescription: String {
         switch self {
         switch self {
         case .Success(let value):
         case .Success(let value):