From 5837e03bc34b11b6916a6f2289c8d9248936eb87 Mon Sep 17 00:00:00 2001
From: MrS0m30n3 <ytubedlg@gmail.com>
Date: Mon, 22 Dec 2014 16:22:20 +0200
Subject: [PATCH] Update downloaders.py docstring

---
 youtube_dl_gui/downloaders.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/youtube_dl_gui/downloaders.py b/youtube_dl_gui/downloaders.py
index c3c89e3..87c4017 100644
--- a/youtube_dl_gui/downloaders.py
+++ b/youtube_dl_gui/downloaders.py
@@ -38,6 +38,18 @@ class YoutubeDLDownloader(object):
     Note:
         For available data keys check self._data under __init__()
         
+    Example:
+        How to use YoutubeDLDownloader from a python script.
+        
+            from downloaders import YoutubeDLDownloader
+            
+            def data_hook(data):
+                print data
+            
+            downloader = YoutubeDLDownloader('/usr/bin/youtube-dl', data_hook)
+            
+            downloader.download(<URL STRING>, ['-f', 'flv'])
+        
     """
     
     OK = 0
@@ -217,6 +229,9 @@ class YoutubeDLDownloader(object):
             stream (subprocess.PIPE): Subprocess pipe. Can be either STDOUT
                 or STDERR.
         
+        Returns:
+            String that contains the stream (STDOUT or STDERR) string.
+        
         """
         if self._proc is None:
             return ''