TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Variables in API documentation From:Lynn Gold <figmo -at- RAHUL -dot- NET> Date:Mon, 5 May 1997 15:01:21 -0700
I've gotten into heated debates with co-workers over this one and
wanted some opinions.
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)
Thanks,
--Lynn
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
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
