Re: Variables in API documentation

Subject: Re: Variables in API documentation
From: Maynard Hogg <maynard -at- GOL -dot- COM>
Date: Tue, 6 May 1997 10:46:39 +0900

At [Mon, 5 May 1997 15:01:21 -0700]
Lynn Gold <figmo -at- RAHUL -dot- NET> wrote:

> When referring to a variable such as a filename, do people still use
> angle-brackets, do they use italics, nothing at all, or do they use
> something else?

> 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.

One dodge that works for DOS is to use upper case for tokens that have
to be typed as is and lower case for variables. (This doesn't work for
Unix shells because RM and rm are two different animals.)


Maynard Hogg
#306, 4-30-10 Yoga, Setagaya-ku, Tokyo, Japan 158
Fax: +81-3-3700-7399
Internet: maynard -at- gol -dot- com
$BF|K\8l$N%a!<%k$b4?7^$7$^$9 (B (Japanese e-mail welcome)
Unsolicited commercial electronic mail sent to this address will be
proofread at a cost of US$200/hour (half-hour minimum).

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: Famous TWs
Next by Author: Borrowing (German and other languages)
Previous by Thread: Variables in API documentation
Next by Thread: Re[2]: Variables in API documentation

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

Sponsored Ads