Instructions for Authors: Difference between revisions
From CASA Guides
Jump to navigationJump to search
Created page with 'Our goal for CASA guides is to maintain up-to-date documentation. The documentation should maintain consistent formatting across the tutorials. Cookbook procedures should be writ…' |
|||
| Line 24: | Line 24: | ||
clean() | clean() | ||
</source> | </source> | ||
Be sure also to include the command to be executed by user to make the scripts more easily testable by developers. | |||
Revision as of 17:44, 25 March 2010
Our goal for CASA guides is to maintain up-to-date documentation. The documentation should maintain consistent formatting across the tutorials. Cookbook procedures should be written such that they can be extracted as python scripts for use by users or developers (for testing purposes).
Embedded Code
Use the "source" formatting option for codes, and "pre" to illustrate the output of a program. For example:
<source lang="python"> # for CASA x = 3 y = 2 vis = "OrionBar-Ka.ms" clean() </source>
will render as
# for CASA
x = 3
y = 2
vis = "OrionBar-Ka.ms"
clean()
Be sure also to include the command to be executed by user to make the scripts more easily testable by developers.
