emacs-devel
[Top][All Lists]
Advanced

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

Documentation of obsolete declarations and aliases.


From: Nick Roberts
Subject: Documentation of obsolete declarations and aliases.
Date: Thu, 5 May 2005 09:05:20 +1200

 > I propose the following doc changes.  The main two points are the following.
 > 
 > Firstly, since the Elisp manual describes the details of how to
 > declare variables obsolete, should it not also document how to declare
 > functions obsolete?  The patch to lispref/functions.texi does that
 > with a new node "Obsolete Functions".

I described how to declare variables obsolete in the node 'Defining Variables'
as defvaralias was described there. The node 'Defining Functions' describes
defalias, so that might be a natural place to put your changes. I also
suggested a single node called 'Obsoletion' where both sets of changes could
go.

 >       ...  The documentation also fails to point out that the main
 > arguments to these macros need to be quoted (which is somewhat
 > surprising for macros.)  I believe that it is better to give a usage
 > example with expansion, as the patches below do, and refer to the
 > docstrings of the two functions they combine for details on those two
 > individual functions.

An example seems like a good idea.


Nick




reply via email to

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