API review for v1.5

[Julian Foad <ju...@btopenworld.com>]

As part of checking that we're ready for a v1.5 release, I think we should 
review all the new and revised APIs.

I hope that each person who is prepared to do some of this will look at some 
APIs that they haven't been working on, and:

   - check the doc strings are understandable (understandable enough to someone 
not intimately familiar with the feature) and accurate;

   - check the APIs provide functionality that will be maintainable in future 
(for example, better to be restrictive rather than overly permissive at first, 
and not mixing up layers of knowledge);

   - where revising an old API, check the "deprecated" and "new" tags and the 
new name and the way in which the old API forwards parameters to the new one;

Can anyone volunteer for a sub-set of this? Choose one library, or choose a 
major feature and look for all of its APIs.

Thanks,
- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: API review for v1.5

[Julian Foad <ju...@btopenworld.com>]

Julian Foad wrote:
> As part of checking that we're ready for a v1.5 release, I think we 
> should review all the new and revised APIs.
> 
> I hope that each person who is prepared to do some of this will look at 
> some APIs that they haven't been working on, and:
> 
>   - check the doc strings are understandable (understandable enough to 
> someone not intimately familiar with the feature) and accurate;
> 
>   - check the APIs provide functionality that will be maintainable in 
> future (for example, better to be restrictive rather than overly 
> permissive at first, and not mixing up layers of knowledge);
> 
>   - where revising an old API, check the "deprecated" and "new" tags and 
> the new name and the way in which the old API forwards parameters to the 
> new one;

I should also have said: What we're looking for urgently is only any problem 
that might make the API a bad thing to release in v1.5. I hope we will not find 
any such problems but it's a good idea to have a look. Improvements that can 
safely be made in a later revision, or documentation fixes, are useful to note 
as well, but need not be fixed urgently.

> Can anyone volunteer for a sub-set of this? Choose one library, or 
> choose a major feature and look for all of its APIs.

If people could say here what subset they will review or already have reviewed, 
that would help us avoid duplication of effort.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org