[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: out of date documentation
From: |
Neil Jerram |
Subject: |
Re: out of date documentation |
Date: |
17 Apr 2001 21:49:55 +0100 |
User-agent: |
Gnus/5.0808 (Gnus v5.8.8) Emacs/20.7 |
>>>>> "Dirk" == Dirk Herrmann <address@hidden> writes:
Dirk> On 16 Apr 2001, Neil Jerram wrote:
>> Thanks - applying in a few moments. Now that the manuals are
>> part of guile-core, I think it's reasonable for them to
>> document the current state of the code in guile-core.
Dirk> Great. Then, however, I do have a suggestion: Instead of
Dirk> writing:
Dirk> Note that, as of Guile 1.4, it is no longer necessary to
Dirk> use the @code{SCM_NIMP} macro before calling a finer-grained
Dirk> predicate to determine @var{x}'s type, such as
Dirk> @code{SCM_CONSP} or @code{SCM_VECTORP}. The definitions of
Dirk> all Guile type predicates now include a call to
Dirk> @code{SCM_NIMP} where necessary.
Dirk> it might be better to formulate things the other way around.
Dirk> I. e. the whole documentation actually documents the current
Dirk> state, and if things have changed compared to a previous
Dirk> version, we write:
Dirk> Note that for versions of Guile prior to 1.4 it was
Dirk> necessary to...
Dirk> and only describe the old usage there, such that this whole
Dirk> paragraph can be taken out at some later time without need
Dirk> to extract anything from it.
Good idea - I will do this.
Thanks!
Neil