From c3d9e73d71c340b9b193c9699920a6c468453e93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Andr=C3=A9e?= Date: Wed, 3 Apr 2013 12:29:02 +0200 Subject: [PATCH] m doc 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, 9 insertions(+), 9 deletions(-) diff --git a/src/ponysay.py b/src/ponysay.py index 20be9009..8bcb438e 100644 --- a/src/ponysay.py +++ b/src/ponysay.py @@ -423,8 +423,8 @@ class Ponysay(): ''' Apply UCS:ise pony names according to UCS settings - @param ponies:list List of all ponies (of interrest) - @param links:map Map to fill with simulated symlink ponies, may be `None` + @param ponies:list List of all ponies (of interrest) + @param links:map? Map to fill with simulated symlink ponies, may be `None` ''' def __ucsise(self, ponies, links = None): ## Read UCS configurations @@ -470,10 +470,10 @@ class Ponysay(): ''' Returns one file with full path, names is filter for names, also accepts filepaths - @param names:list Ponies to choose from, may be `None` - @param alt:bool For method internal use... - @param ponydirs:itr The pony directories to use - @return :str The file name of a pony + @param names:list? Ponies to choose from, may be `None` + @param alt:bool For method internal use... + @param ponydirs:itr? The pony directories to use + @return :str The file name of a pony ''' def __getponypath(self, names = None, alt = False, ponydirs = None): if ponydirs is None: ponydirs = self.ponydirs @@ -496,9 +496,9 @@ class Ponysay(): ''' Get ponies that fit the terminal - @param fitting The set to fill - @param requirement The maximum allowed value - @param file The file with all data + @param fitting:add(str)→void The set to fill + @param requirement:int The maximum allowed value + @param file:istream The file with all data ''' def getfitting(fitting, requirement, file): data = file.read() # not too much data, can load everything at once