guile-devel
[Top][All Lists]
Advanced

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

Re: ChangeLog or not?


From: Andy Wingo
Subject: Re: ChangeLog or not?
Date: Tue, 06 Mar 2012 21:39:06 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/23.3 (gnu/linux)

On Tue 06 Mar 2012 19:13, Mark H Weaver <address@hidden> writes:

>>   but please put the full explanation in comments
>>   in the code, where people will see it whenever they see the code.
>
>> Do you think it’s bikeshedding?  :-)
>
> Not at all!  Thank you for nudging us in the direction of better code
> comments, regression tests, etc.  These are very important for Guile's
> long-term health.

I agree in general.

I wonder though about some specific cases.  For example,
performance-related changes.  Justifying performance improvements
necessarily depends on a description of two different revisions of a
piece of functionality -- and there's no sense for describing an
interface that's not there any more.  For a change motivated by
performance, then, I would expect to see more in the change log than in
the comments.

Similarly for "X is temporarily moved to Y but will be moved to Z in a
future commit".

There are probably other cases.  Dunno, perhaps I have not yet been
fully indoctrinated :-)

Andy
-- 
http://wingolog.org/



reply via email to

[Prev in Thread] Current Thread [Next in Thread]