Add documentation for missing members

bignerdranch · Apr 28, 2018 · 2c91bdf · 2c91bdf
1 parent daf8b63
commit 2c91bdf
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/Sources/Task/Either.swift b/Sources/Task/Either.swift
@@ -9,7 +9,14 @@
 /// A type that can exclusively represent either some result value of a
 /// successful computation or a failure with an error.
 public protocol Either: CustomStringConvertible, CustomDebugStringConvertible {
+    /// One of the two possible results.
+    ///
+    /// By convention, the left side is used to hold an error value.
     associatedtype Left = Error
+
+    /// One of the two possible results.
+    ///
+    /// By convention, the right side is used to hold a correct value.
     associatedtype Right
 
     /// Derive a result from a failable function.

diff --git a/Sources/Task/TaskGroup.swift b/Sources/Task/TaskGroup.swift
@@ -21,6 +21,8 @@ import Dispatch
 public struct TaskGroup {
 
     private let group = DispatchGroup()
+
+    /// Creates the empty task group.
     public init() {}
 
     private var queue: DispatchQueue {