From acc543cfe093cddd3c1f2fb93269557088c006fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Andr=C3=A9e?= Date: Sat, 17 Aug 2013 07:35:04 +0200 Subject: [PATCH] add documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/ponysay.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/ponysay.py b/src/ponysay.py index dc8c8618..56d313a6 100755 --- a/src/ponysay.py +++ b/src/ponysay.py @@ -1054,6 +1054,12 @@ class Ponysay(): def __getHyphen(self, args): + ''' + Gets the hyphen to use a at hyphenation + + @param args:ArgParser Command line options + @return :str The hyphen string to use at hyphenation + ''' hyphen = os.environ['PONYSAY_WRAP_HYPHEN'] if 'PONYSAY_WRAP_HYPHEN' in os.environ else None if (hyphen is None) or (len(hyphen) == 0): hyphen = '-' @@ -1064,6 +1070,12 @@ class Ponysay(): def __getLinkColour(self, args): + ''' + Gets the colour of balloon links + + @param args:ArgParser Command line options + @return :str The colour of balloon links + ''' linkcolour = '' if args.opts['--colour-link'] is not None: linkcolour = '\033[' + ';'.join(args.opts['--colour-link']) + 'm' @@ -1071,6 +1083,12 @@ class Ponysay(): def __getBalloonColour(self, args): + ''' + Gets the colour of balloons + + @param args:ArgParser Command line options + @return :str The colour of balloons + ''' ballooncolour = '' if args.opts['--colour-bubble'] is not None: ballooncolour = '\033[' + ';'.join(args.opts['--colour-bubble']) + 'm'