Add inline comment describing the MaterializedSequenceResult enum type

sgleadow · kzaher · commit 44696834469c · 2017-08-23T01:08:36.000+02:00
diff --git a/RxBlocking/BlockingObservable+Operators.swift b/RxBlocking/BlockingObservable+Operators.swift
@@ -10,6 +10,14 @@
     import RxSwift
 #endif
 
+/// The `MaterializedSequenceResult` enum represents the materialized
+/// output of a BlockingObservable.
+///
+/// If the sequence terminates successfully, the result is represented
+/// by `.completed` with the array of elements.
+///
+/// If the sequene terminates with error, the result is represented
+/// by `.failed` with both the array of elements and the terminating error.
 public enum MaterializedSequenceResult<T> {
     case completed(elements: [T])
     case failed(elements: [T], error: Error)
