"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "docs/users_guide/comments.rst" between
cheetah3-3.1.0.tar.gz and cheetah3-3.2.0.tar.gz

About: Cheetah3 is a template engine and code generation tool for e.g. for Web development or Java, SQL, LaTeX, form email ... (written in Python).

comments.rst  (cheetah3-3.1.0):comments.rst  (cheetah3-3.2.0)
Comments Comments
======== ========
(comments)
Comments are used to mark notes, explanations, and decorative text Comments are used to mark notes, explanations, and decorative text
that should not appear in the output. Cheetah maintains the that should not appear in the output. Cheetah maintains the
comments in the Python module it generates from the Cheetah source comments in the Python module it generates from the Cheetah source
code. There are two forms of the comment directive: single-line and code. There are two forms of the comment directive: single-line and
multi-line. multi-line.
All text in a template definition that lies between two hash All text in a template definition that lies between two hash
characters ({##}) and the end of the line is treated as a characters ({##}) and the end of the line is treated as a
single-line comment and will not show up in the output, unless the single-line comment and will not show up in the output, unless the
two hash characters are escaped with a backslash. two hash characters are escaped with a backslash.
skipping to change at line 57 skipping to change at line 55
Description of method2. Description of method2.
$arg1, string, a phrase. $arg1, string, a phrase.
*# *#
#def method2($arg1) #def method2($arg1)
... lines ... ... lines ...
#end def #end def
Docstring Comments Docstring Comments
------------------ ------------------
(comments.docstring)
Python modules, classes, and methods can be documented with inline Python modules, classes, and methods can be documented with inline
'documentation strings' (aka 'docstrings'). Docstrings, unlike 'documentation strings' (aka 'docstrings'). Docstrings, unlike
comments, are accesible at run-time. Thus, they provide a useful comments, are accesible at run-time. Thus, they provide a useful
hook for interactive help utilities. hook for interactive help utilities.
Cheetah comments can be transformed into doctrings by adding one of Cheetah comments can be transformed into doctrings by adding one of
the following prefixes: the following prefixes:
:: ::
 End of changes. 2 change blocks. 
4 lines changed or deleted 0 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)