 |
 |
 |
Cheetah Users' Guide |  |
 |
|
|
|
|
Cheetah Users' Guide | |
|
|
Python modules, classes, and methods can be documented with inline 'documentation strings' (aka 'docstrings'). Docstrings, unlike comments, are accesible at run-time. Thus, they provide a useful hook for interactive help utilities.
Cheetah comments can be transformed into doctrings by adding one of the following prefixes:
##doc: This text will be added to the method docstring
#*doc: If your template file is MyTemplate.tmpl, running "cheetah compile"
on it will produce MyTemplate.py, with a class MyTemplate in it,
containing a method .respond(). This text will be in the .respond()
method's docstring. *#
##doc-method: This text will also be added to .respond()'s docstring
#*doc-method: This text will also be added to .respond()'s docstring *#
##doc-class: This text will be added to the MyTemplate class docstring
#*doc-class: This text will be added to the MyTemplate class docstring *#
##doc-module: This text will be added to the module docstring MyTemplate.py
#*doc-module: This text will be added to the module docstring MyTemplate.py*#
|
|
|
Cheetah Users' Guide | |
|
|