[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: r1730389 - /subversion/trunk/subversion/libsvn_repos/log.c

From: Ivan Zhakov <ivan_at_visualsvn.com>
Date: Tue, 16 Feb 2016 13:30:31 +0300

On 16 February 2016 at 08:47, Stefan Fuhrmann <stefan2_at_apache.org> wrote:
> On 15.02.2016 09:39, Ivan Zhakov wrote:
>>
>> On 14 February 2016 at 22:25, <stefan2_at_apache.org> wrote:
>>>
>>> Author: stefan2
>>> Date: Sun Feb 14 19:25:12 2016
>>> New Revision: 1730389
>>>
>>> URL: http://svn.apache.org/viewvc?rev=1730389&view=rev
>>> Log:
>>> Begin work on the svn_repos_get_logs4 to svn_repos_get_logs5 migration.
>>>
>>> As a first step, we introduce what will become svn_repos_get_logs5 as
>>> a static function and implement svn_repos_get_logs4 as a wrapper.
>>
>>
>> The svn_repos__get_logs5() doesn't have docstring, while as far I
>> understand it has very tricky semantic of delivering data using two
>> callbacks. Without documented svn_repos__get_logs5() API it's almost
>> impossible to get idea of all following commits in log.c
>
>
> The API definition / migration is complete now and the next
> step is publish it. It'll then get a proper docstring.
>
You do this in the wrong way because nobody can meaningfully review
commits you've already made without this doctring.

Existence of docstring will also help not to develop the program in
the bottom-up mode. If you don't have all the details at the moment,
even the preliminary version of docstring will help.

-- 
Ivan Zhakov
Received on 2016-02-16 11:30:57 CET

This is an archived mail posted to the Subversion Dev mailing list.