Re: [PATCH]: notification progress improvement/fixes (issue #901)

On 8/31/05, David Anderson <david.anderson@calixo.net> wrote:

> > + * In order to avoid backward compatibility problems, clients should use
> > + * svn_ra_create_callbacks() to allocate and initialize this structure
> > + * instead of doing so themselves.
>
> Don't give a choice: "In order to ease future compatibility, clients
> must use svn_ra_create_callbacks() to allocate and initialize this
> structure."

Hmm, I used the comment in svn_client_create_context() and changed it
to fit svn_ra_create_callbacks().
Maybe we should change the comment there too? Because in
subversion/include/svn_client.h, line 477, it also states "should use".

> > +* The current implementation never returns error, but callers should
> > +* still check for error, for compatibility with future versions.
>
> No need to speak of implementation in public API documentation. The
> function returns svn_error_t*, which means errors may be thrown and must
> be handled one way or another, period.

Again, the docstrings for svn_client_create_context() have the same comment.
(just mentioning it here because if it's not good here, we should
change it there too).

Stefan

-- 
       ___
  oo  // \\      "De Chelonian Mobile"
 (_,\/ \_/ \     TortoiseSVN
   \ \_/_\_/>    The coolest Interface to (Sub)Version Control
   /_/   \_\     http://tortoisesvn.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org