Re[2]: Variables in API documentation

Subject: Re[2]: Variables in API documentation
From: Janet_Valade -at- SYSTECH -dot- COM
Date: Tue, 6 May 1997 07:56:50 PST

> For example, would you use:

> a) rm <filename>
> (using angle brackets that are not supposed to be typed as part of the
> command)

> b) rm *filename*
> (where the asterisks here are denoting italicized text)

> c) rm filename
> (no special demarcation)

My Unix/DOS bias (note that rm is a Unix shell command) rules the first
two out immediately since they already have a predefined meaning to
Unix/DOS shells.

I'm confused here. I prefer to use b). The UNIX books I have,
including the nutshell books which are pretty well accepted, use
method b). I agree method a) is not a good idea since some folks
will surely type the brackets. But, I don't understand what you mean
about method b).


Janet Valade
Technical Writer
Systech Corp, San Diego, CA
janet_valade -at- systech -dot- com

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
Search the archives at or search and
browse the archives at

Previous by Author: Re[2]: bad employers/clients list
Next by Author: Education on Resume
Previous by Thread: Re: Variables in API documentation
Next by Thread: Re: Variables in API documentation

What this post helpful? Share it with friends and colleagues:

Sponsored Ads