PonyMirrors/ponysay
1
0
Fork 0
mirror of https://github.com/erkin/ponysay.git synced 2025-03-23 04:07:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

m doc

Browse source 
Signed-off-by: Mattias Andrée <maandree@operamail.com>
This commit is contained in:
Mattias Andrée 2013-04-03 12:29:02 +02:00
parent 93851e9d19
commit c3d9e73d71
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/ponysay.py
View file

@ -423,8 +423,8 @@ class Ponysay():
''' '''
Apply UCS:ise pony names according to UCS settings Apply UCS:ise pony names according to UCS settings
@param ponies:list<str> List of all ponies (of interrest) @param ponies:list<str> List of all ponies (of interrest)
@param links:map<str, str> Map to fill with simulated symlink ponies, may be `None` @param links:map<str, str>? Map to fill with simulated symlink ponies, may be `None`
''' '''
def __ucsise(self, ponies, links = None): def __ucsise(self, ponies, links = None):
## Read UCS configurations ## Read UCS configurations
@ -470,10 +470,10 @@ class Ponysay():
''' '''
Returns one file with full path, names is filter for names, also accepts filepaths Returns one file with full path, names is filter for names, also accepts filepaths
@param names:list<str> Ponies to choose from, may be `None` @param names:list<str>? Ponies to choose from, may be `None`
@param alt:bool For method internal use... @param alt:bool For method internal use...
@param ponydirs:itr<str> The pony directories to use @param ponydirs:itr<str>? The pony directories to use
@return :str The file name of a pony @return :str The file name of a pony
''' '''
def __getponypath(self, names = None, alt = False, ponydirs = None): def __getponypath(self, names = None, alt = False, ponydirs = None):
if ponydirs is None: ponydirs = self.ponydirs if ponydirs is None: ponydirs = self.ponydirs
@ -496,9 +496,9 @@ class Ponysay():
''' '''
Get ponies that fit the terminal Get ponies that fit the terminal
@param fitting The set to fill @param fitting:add(str)→void The set to fill
@param requirement The maximum allowed value @param requirement:int The maximum allowed value
@param file The file with all data @param file:istream The file with all data
''' '''
def getfitting(fitting, requirement, file): def getfitting(fitting, requirement, file):
data = file.read() # not too much data, can load everything at once data = file.read() # not too much data, can load everything at once