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.
jdavid -at- FARABI -dot- COM,Internet writes:
>the value, and uses it in the current function. I replaced "returns" with
>"retrieves", but the reviewer didn't like it.
>
>I'd rather use "retrieves" because it shows how the program goes to a
>destination and returns with information. I don't like "returns" because
>only indicates the journey back.
>
>Is "returns" an industry standard (check out Dilbert today at
>www.dilbert.com for a related funny) in the programming world, or can I
>push
>for the more accurate verb?
>
>Please respond off-list and I'll post a summary of what I get.
>--
>Be seeing you,
Was this the programmer person?
Anyway there are all sorts of functions with Get this "GetThat" names in
many APIs.
Seems to be a good verb to stick on the front of a function name (provided
the function Gets something).
Can't totally get what the GET thing does from your message, but if you're
documneting
an API, return (as in return value, or the return value of the function)
is a very
standard term used in programming. This may be what the reviewer is
reacting to, although
to you returns indicates one way, it's such a usual term for a function
that
retrieves sounds imprecise (to the reviewer).
Doug
Doug Nickerson
Bourne, MA.
Programmer/author/person/professional
doug_nickerson -at- onsetcomp -dot- com
