quick help file fixes

Jason Quinn wrote on Jan 13, 2009

bpmedit is missing from the image.tv package menu.

The good news is that there may not be many (if any) of these omissions left in IRAF proper. These menus are rather accurate considering they aren't generated on the fly.

Jason

---

Mike Fitzpatrick wrote on Jan 13, 2009

Thanks Jason, fixed for the next release.

-Mike

---

Jason Quinn wrote on Jan 13, 2009

Here are some more quick help fixes.

*In the language package, the whereis help is not setup correctly. The tasks which and whereis share a help file.

language> help whereis
Cannot find help block for `whereis' in `pkg$language/doc/which.hlp'
language> 

*Also in language, the tasks imaccess, defvar, and onerror are missing help files and are also missing from the package's "help" list.

*In noao.nobsolete, the "See Also" section for badpiximage says to see "text2image" when I think it's supposed to be the text2mask task in the proto package. The help for badpiximage should probably explicitly state "This task was made obsolete by...".

Cheers,
Jason

---

Mike Fitzpatrick wrote on Jan 13, 2009

Hi Jason,

Thanks, these are fixed for the next release. The onerror function was never fully implemented and so I left it undocumented until/unless I ever get back to finishing it.

-Mike

---

Jason Quinn wrote on Jan 13, 2009

Here are a bunch of help file fixes for some tasks in the images.immatch package.

xyxymatch

*In NAME section, "Match pixels coordinate lists..." should be either "Match pixel coordinate lists..." or "Match pixels in coordinate lists...".
*The input and reference file's format is never actually mentioned in the text of this help file
*In the PARAMETERS section for output, I would use upper case letters for the list after the colon instead of numbers to make it easier to read.
*In the PARAMETERS section for refpoints, "input tie point in" should be "input tie points in"
*In the PARAMETERS section for xref and yref... "Xref and xref" should be "Xref and yref".
*In the PARAMETERS section for ratio, there is an instance of "Ration" for "ratio".
*In the DESCRIPTION section and above the equations, there is "xrotation, xrotation" that should be "xrotation, yrotation".
*In the ALGORITHMS section, change "which match int the" to "which match in the".

geomap

*The top line of the help should say "images.immatch" instead of just "immatch" to match geotran, geoxytran, gregister
*In the PARAMETERS section for calctype, the first sentence needs a "the".... "The precision of the coordinate...".
*In the DESCRIPTION section's 4th paragraph, there's an extra carraige return.
*In the DESCRIPTION section's 6th paragraph, there's "avaible" that should "avaible" (might be fixed from the files I sent though).
*In the DESCRIPTION section, above the available keystroke commands, change "The available keystroke command are..." to "The available keystroke commands are..." (with an 's').
*In the DESCRIPTION section, below the available keystroke commands, change "along" to "alone".
*In the DESCRIPTION section, below the colon command listing, the task is GREGISTER, not REGISTER. Perhaps GEOXYTRAN should also be mentioned here.

geotran

*In the USAGE section, "transform" should be "transforms"... cf to PARAMETER section and the related help files.
*In the PARAMETERS section for transforms, change "must 1" to "must be one".
*In the PARAMETER section for shift, there's a "tha" for "the". (might be fixed)

geoxytran

*In the PARAMETER section for transforms, change the comma to a period in "transformation, If".
*In the PARAMETER section for direction, change "backwards" to "backward".
*In the PARAMETER section for xformat, the last sentence has two unwanted commas.
*In the DESCRIPTION section equations, there's equations that use "xo" and "yo" while the text refers to them as "x0" and "y0" (two sets of equations do it). (zero vs the letter 'o').
*In EXAMPLES, Example 2 has an extra space after the listing number.
*In SEE ALSO, geotran and gregister should be listed too.

gregister

*In NAME, there's two spaces before and after the "--" instead of the usual one.
*In DESCRIPTION's 2nd to last paragraph, "... should set these number to" should be..."... should set these numbers to...".

FORMATS
The xyxymatch and geoxytran tasks have identical sections called FORMATS. The section is plagued by the same upper vs lower case problems regarding the format specifiers that I've found before. (There is also a "H" specifier shown in the examples that is not listed with the other specifiers.) Perhaps the best idea would be to create a new "formats" help file so that there is a central spot for the formatting information. Any tasks needing that information can refer the user to it.

Jason

---

Mike Fitzpatrick wrote on Jan 13, 2009

Hi Jason,

Thanks. Except for the FORMATS section I've made all the changes. FORMATS is used in a number of places beyond just these tasks so I've put it on the list for later when I have time to review all the tasks.

-Mike

---

Jason Quinn wrote on Jan 13, 2009

*After you splot a spectra and use the function mode 'f', the menu shown in the graphics window ends with

p=+k   m=*k   +,-,*,/=2spec ops

I would recommend it be changed to

p+=k   m*=k   +,-,*,/=spec2 ops

because spec2 is the actual second spectrum name used by the task and help file and the "+="-style syntax is more standard (and used by IRAF).

Some splot help fixes:

*The task help lists "wcreset" as one of the "options" but it the rest of the documentation uses "wreset".

*In the epar description for wavelength, there is a colon (Dispersion coordinate:) that shouldn't be there.

*In the splot help, the options parameter has The "overplot" options overplots but should be The "overplot" option overplots.

*For the description of the mag parameter, the description should start on the next line to match the other parameters. The last sentence ends strangely ("is in" probably should just be "in") . Plus it needs a period.

*The DESCRIPTION section's 2nd word, "option" , is used to describe the "options" parameter. Later in this same sentence there is a double a ("a a").

*In the 5th paragraph of the DESCRIPTION section, "replace then in the new output image"..... I think should be "replace them in the new output image". (This sentence really could use a comma too after "saved".)

*In the DESCRIPTION section's discussion of the keystrokes, the 'a' (expand) section has "See also 'w', and 'z'.", which has an unwanted comma.

*In the 'f' (function mode) section, uncapitalize function in "q Quit Function mode".

*In the "g Get another spectrum." section, the last two words, "is necessary" probably should be "as necessary".

*In the 't' section (ICFIT) the '-' description formating is offset wrt the other descriptions.

*For the ',' command (Shift the graph window to the left), it should not have apostrophes around the comma, cf with the '.' command just below.

*In the EXAMPLES section, there is a "Therefore it these examples..." that should be "Therefore these examples...".

Jason

PS I've been using splot a lot recently and it occurred to me that it'd be good if IRAF had a default spectrum similar to dev$pix that could be used to help report problems with 1D tasks.

---

Last post on Jan 13, 2009