Document Subscription's unsubscribe.

Summary: Closes #5 Reviewers: O2 Material Motion, #material_motion, O4 Material Apple platform reviewers, chuga Reviewed By: O4 Material Apple platform reviewers, chuga Tags: #material_motion Differential Revision: http://codereview.cc/D2272
material-motion · Dec 13, 2016 · 75ec811 · 75ec811
1 parent eb8abdf
commit 75ec811
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/IndefiniteObservable.swift b/src/IndefiniteObservable.swift
@@ -90,6 +90,11 @@ public final class Subscription {
     self.disconnect = disconnect
   }
 
+  /**
+   Unsubscribing will disconnect all observables from their sources.
+
+   Invoked automatically on deallocation.
+   */
   public func unsubscribe() {
     disconnect?()
     disconnect = nil