Re: When deprecating, always say what the replacement is.



On Tue, 2010-02-23 at 19:59 +0100, Murray Cumming wrote:
> On Tue, 2010-02-23 at 19:17 +0100, Javier Jardón wrote:
> > 2010/2/23 Murray Cumming <murrayc murrayc com>:
> > > When we deprecate API, please remember to document what the replacement
> > > is. People forget this quite often.
> > >
> > > A small recent example that doesn't do this:
> > > http://git.gnome.org/browse/gtk
> > > +/commit/?id=bb1824c131f247c2ef64f3c5f8b9ffe3885c9d90
> > 
> > Indeed, the info about the replacements is on the deprecated
> > functions/macros documentation (inline comments ;)):
> 
> No, "Deprecated: 2.20: Do not use it." is not good enough.

As a matter of fact, it is. There is not supposed to be any
replacement for the stuff that says "Do not use it". Everything
that has a replacement is however documented.

So please, a little research before bashing perfectly good commits.

ciao,
--mitch




[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]