From a2c79a031fdc139a67eb153d85116cd14e39ddba Mon Sep 17 00:00:00 2001
From: Kare Morstol <kare@nottoobadsoftware.com>
Date: Thu, 28 Apr 2016 02:12:17 +0200
Subject: [PATCH] Add documentation for onOutput and onStringOutput.

---
 Sources/SwiftShell/Stream.swift | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/Sources/SwiftShell/Stream.swift b/Sources/SwiftShell/Stream.swift
index 0c60912..aba18bb 100644
--- a/Sources/SwiftShell/Stream.swift
+++ b/Sources/SwiftShell/Stream.swift
@@ -53,9 +53,15 @@ extension ReadableStream: ShellRunnable {
 	}
 }
 
-/** Callback with when ReadableStream has data.*/
 extension ReadableStream {
 
+	/** 
+	`handler` will be called whenever there is new output available.
+	Pass `nil` to remove any preexisting handlers.
+
+	- note: if the stream is read from outside of the handler, or more than once inside
+	the handler, it may be called once when stream is closed and empty.
+	*/
 	public func onOutput ( handler: ((ReadableStream) -> ())? ) {
 		guard let handler = handler else {
 			filehandle.readabilityHandler = nil
@@ -66,6 +72,11 @@ extension ReadableStream {
 		}
 	}
 
+
+	/**
+	`handler` will be called whenever there is new text output available.
+	Pass `nil` to remove any preexisting handlers.
+	*/
 	public func onStringOutput ( handler: ((String) -> ())? ) {
 		if let h = handler {
 			filehandle.readabilityHandler = { (NSFileHandle) in