Re: "test if" vs. "determine whether" - for API function descriptions ?
For an API Reference, Iâve got lots (and lots) of descriptions for functions that return TRUE or FALSE depending on whether a given condition/state/whatever is true or false.
And Iâm wondering which (brief, as in the @brief command in Doxygen) descriptionâs start text might be âbetterâ, âmore quickly grokedâ, âeasier for ESL readers to understandâ:
* Test if <condition, such as âthe object is the first in the listâ>.
* Determine whether <condition, such as âthe object is the first in the listâ>.
Thereâs no consistency in the function names (and I am not about to try to get the code refactored). Names might begin or include âisConditionâ, âConditionâ, âcheckIfConditionâ, and so on; or they might not.
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
"test if" vs. "determine whether" - for API function descriptions ?: From: Monique Semp
Previous by Author:
Re: Editors that support conditionals
Next by Author: Re: Seeking Online Help Surveys Advice
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 ?
Search our Technical Writing Archives & Magazine