From a60e5a821323f5c134078b0af90fc2068cd47859 Mon Sep 17 00:00:00 2001 From: MrS0m30n3 Date: Sun, 21 Dec 2014 22:54:45 +0200 Subject: [PATCH] Update docstrings --- youtube_dl_gui/__main__.py | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/youtube_dl_gui/__main__.py b/youtube_dl_gui/__main__.py index 2dda59b..916f6c1 100644 --- a/youtube_dl_gui/__main__.py +++ b/youtube_dl_gui/__main__.py @@ -1,6 +1,25 @@ #!/usr/bin/env python2 -''' Youtube-dlg __main__ file. ''' +"""Youtubedlg __main__ file. + +__main__ file is a python 'executable' file which calls the youtubedlg +main() function in order to start the app. It can be used for starting +the app from inside the package OR it can be used for starting the app +from a different directory after you have installed the +youtube_dl_gui package. + +Example: + In order to run the app from inside the package. + + $ cd + $ python __main__.py + + In order to run the app from /usr/local/bin AFTER + you have installed the package. + + $ youtube-dlg + +""" import sys