Re: "test if" vs. "determine whether" - for API function descriptions ?

Subject: Re: "test if" vs. "determine whether" - for API function descriptions ?
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: Monique Semp <monique -dot- semp -at- earthlink -dot- net>
Date: Tue, 5 Jan 2016 14:04:08 -0800

In cases like that, I say something like "returns a <whatever>, on
which you may use <some other function> to return TRUE if <condition
A> or FALSE if <condition B>."

I'm really not comfortable characterizing returns.

On Tue, Jan 5, 2016 at 11:51 AM, Monique Semp
<monique -dot- semp -at- earthlink -dot- net> wrote:
>> My default phrasing is "returns TRUE if ...."
>
>
> Ah, but the issue again is inconsistency. Some functions directly return
> TRUE/FALSE, but many others return a higher-level function-status-ok value,
> and return the condition's TRUE/FALSE through a function call parameter.
>
> So "returns..." won't work in these situations, and we're back to using
> "test if" or "determine whether", or some such thing.
>
> Certainly the ideal would be a coding standard that all engineers follow,
> and the standard would say how to name functions of this sort and how to
> return the value. But that's not likely to be followed even if implemented.
>
> -Monique
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
"test if" vs. "determine whether" - for API function descriptions ?: From: Monique Semp
Re: "test if" vs. "determine whether" - for API function descriptions ?: From: Robert Lauriston
Re: "test if" vs. "determine whether" - for API function descriptions ?: From: Monique Semp

Previous by Author: Re: "test if" vs. "determine whether" - for API function descriptions ?
Next by Author: drawing program that can import SVG generated by Railroad Diagram Generator?
Previous by Thread: Re: "test if" vs. "determine whether" - for API function descriptions?
Next by Thread: RE: "test if" vs. "determine whether" - for API function descriptions ?


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

Sponsored Ads


Sponsored Ads