================================== Marking Code comment abbreviations ================================== -IAN! idallen@idallen.ca I use these abbreviations when marking your shell scripts: cat - unnecessary+inefficient use of "cat" pipe to command stdin com - missing or incorrect comment lines (comments must begin with "#") exi - missing or incorrectly placed "exit" statement exp - message does not say exactly what kind of input is expected from the user ind - incorrect indentation or code layout (line too long, etc.) log - logic error (e.g. exiting before printing error message) mis - missing code required by specification ner - not an error message; use stdout; do not send to standard error nnc - not necessary (probably correct; but, should be simplified or left out) old - one-line Summary description is missing or incorrect (script_style.txt) pro - missing or unhelpful prompt; or prompt on stdout instead of stderr pur - Purpose is missing, incomplete, or incorrect (see script_style.txt) quo - quoting is incorrect (including extra or missing quotes) ser - error message does not appear on standard error (script_style.txt) sho - error message does not show or count exactly what was entered by user sim - simplify; code is too complex syn - usage Syntax line is missing or incorrect (see script_style.txt) tmp - temporary file must be unique name under /tmp/ directory; remove at end unk - unknown purpose (code, comment, or syntax) If you don't understand why I made the comment, come see me. "Less code is better code"