I love discussions about what words to use in documentation. :)
Agreed that indeterminate doesn't capture what you're trying to convey. How
about re-writing it. Instead of:
> When a build is {@link #isBuilding() in progress}, this method
> returns an intermediate result.
Use this:
> The value returned by this method can change while a build is
> {@link #isBuilding() in progress}.
-- Dean
On 3/22/12 7:38 AM , "Linards Liepi?š" <[email protected]> wrote:
> Well, imho it is not even undefined. Return is always defined in system ABI. I
> would rather say it is unvalued ;)
>
> 2012/3/22 Adam Hawthorne <[email protected]>
>> On Wed, Mar 21, 2012 at 22:05, Kohsuke Kawaguchi <[email protected]>
>> wrote:
>>> On 03/21/2012 09:54 AM, Dean Yu wrote:
>>>> Should that be "indeterminate result" instead of "intermediate result"?
>>>
>>> It's not returning a random or undefined value, so IIUC, "indeterminate" is
>>> not the right word.
>>>
>>> The semantics I wanted to convey was that it's not finalized yet and it can
>>> change (worsen, more specifically).
>>>
>>> What's the right word for it?
>>
>> Hmm... seems like "undefined" would do well since its value is not yet
>> clearly defined.
>>
>> And also, your bikeshed should be red ;)
>>
>> Adam