emacs-devel
[Top][All Lists]
Advanced

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

Re: Incompatible change without "warning"


From: Nick Roberts
Subject: Re: Incompatible change without "warning"
Date: Wed, 27 Apr 2005 09:35:22 +1200

 > > The current documentation for these related functions uses different
 > > argument names which I think is confusing:
 > 
 > I don't think it's confusing:
 > - `defvaralias' creates a variable alias.
 >   Neither of the two variables is known to be "old" or "new" or "obsolete".
 >   One is the "base", the other is the "alias".
 > - define-obsolete-variable-alias OTOH just *uses* defvaralias in one specific
 >   context (in order to preserve backward compatibility witha now obsolete
 >   variable), so the names can be more specific.
 > 
 > >  - Function: defvaralias variable new &optional docstring
 > 
 > That would sound wrong to me: the documentation should generally refer to
 > what a function *does*, not to how the function is used.

Yes, you're right - I've been too narrow in my thinking. However, my
first point was about using the same argument names in the manual and the
documentation string. Would this not generally be a good idea?

Nick




reply via email to

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