From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 21 Nov 2013 22:04:36 GMT
Subject: Re: [RFC PATCH] Revamp git-cherry(1)
Message-ID: <xmqqwqk12yyz.fsf@gitster.dls.corp.google.com>
In-Reply-To: <87pppt31v9.fsf@thomasrast.ch>

Thomas Rast <tr@thomasrast.ch> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>>>  OPTIONS
>>>  -------
>>>  -v::
>>> -	Verbose.
>>> +	Verbose.  Currently shows the commit subjects next to their
>>> +	SHA1.
>>
>> Whenever I see "Currently", it makes me wonder "why does it need to
>> say that? Is there a plan to change it soon, and if so where is the
>> plan described?".
>
> I wanted to avoid documenting exactly what it does, so that in the
> future it could do more than that.  Is that overly paranoid?

I would have to say so. After all, the documentation is supposed to
describe the current state of affairs, and we would update it when
"the current state" changes. In places, we may express our plan to
forewarn readers of planned upcoming changes, but still...