[Happydoc-checkins] CVS: HappyDoc/happydoclib happyformatter.py,1.4,1.5
Brought to you by:
doughellmann,
krlosaqp
From: Doug H. <dou...@us...> - 2002-02-03 21:49:30
|
Update of /cvsroot/happydoc/HappyDoc/happydoclib In directory usw-pr-cvs1:/tmp/cvs-serv10045/happydoclib Modified Files: happyformatter.py Log Message: Fixed documentation for default implementation of writeText() so that all arguments are reflected. Index: happyformatter.py =================================================================== RCS file: /cvsroot/happydoc/HappyDoc/happydoclib/happyformatter.py,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** happyformatter.py 2002/02/02 13:46:04 1.4 --- happyformatter.py 2002/02/03 21:49:27 1.5 *************** *** 222,227 **** return str ! def writeText(self, text, output, quote=1): ! "Write the text to the output destination." text = self._unquoteString(text) self.writeRaw(text, output) --- 222,241 ---- return str ! def writeText(self, text, output, textFormat, quote=1): ! """Write the text to the output destination. ! ! Arguments ! ! 'text' -- text to output ! ! 'output' -- output file object ! ! 'textFormat' -- String identifying the format of 'text' so ! the formatter can use a docstring converter to convert the ! body of 'text' to the appropriate output format. ! ! 'quote=1' -- Boolean option to control whether the text ! should be quoted to escape special characters. ! """ text = self._unquoteString(text) self.writeRaw(text, output) |