Commits

Bob Garwood authored 16ab46a4901
CAS-10550: make the parameter name in inline help examples match the actual parameter name

gcwrap/tasks/asdmsummary.xml

Modified
4 4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5 5 xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd
6 6 file:///opt/casa/code/xmlcasa/xml/casa.xsd">
7 7
8 8 <!-- This is the parameter set for asdmsummary -->
9 9
10 10 <task type="function" name="asdmsummary" category="information" visibility="experimental">
11 11
12 12 <shortdescription>Summarized description of an ASDM dataset.</shortdescription>
13 13
14 - <description>Given an ASDM directory, this task will print informations about the content of the dataset contained in that directory (down to the level of a subscan).</description>
14 + <description>Given an ASDM directory, this task will print, to the CASA log, information about the content of the dataset contained in that directory (down to the level of a subscan).</description>
15 15
16 16 <input>
17 17
18 18 <param type="string" name="asdm" mustexist="true">
19 19 <description>Name of input ASDM directory</description>
20 20 <value></value>
21 21 </param>
22 22
23 23 </input>
24 24
25 25 <returns type="void"/>
26 26
27 27 <example>
28 28
29 29 The asdmsummary task prints to the CASA log a description of the content of an SDM dataset.
30 30
31 31 Example:
32 32
33 - asdmsummary(sdm='10C-119_sb3070258_1.55628.42186299768')
33 + asdmsummary(asdm='10C-119_sb3070258_1.55628.42186299768')
34 34
35 35 Prints information about the requested ASDM dataset to the CASA logger.
36 36
37 37 Keyword argument:
38 38
39 39 asdm -- Name of input ASDM directory.
40 - example: sdm='10C-119_sb3070258_1.55628.42186299768'
40 + example: asdm='10C-119_sb3070258_1.55628.42186299768'
41 41
42 42 </example>
43 43
44 44 </task>
45 45
46 46 </casaxml>

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut