[Top][All Lists]

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

Re: The new keymap functions

From: Eli Zaretskii
Subject: Re: The new keymap functions
Date: Tue, 16 Nov 2021 17:13:01 +0200

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: dgutov@yandex.ru,  joostkremers@fastmail.fm,  emacs-devel@gnu.org
> Date: Tue, 16 Nov 2021 15:24:09 +0100
> Eli Zaretskii <eliz@gnu.org> writes:
> > The changes to the ELisp manual completely removed the documentation
> > of global-set-key and other "legacy" functions, AFAICT.  I don't think
> > we can do that: the code which uses those will remain with us for the
> > years to come, and Lisp programmers should be able to read and
> > understand what these functions do.  It is okay to say "don't use
> > those in new code" (as you already did say), but we should put back
> > the documentation of those few functions.  There aren't too many of
> > them, and their documentation is quite short, so it isn't a big deal
> > to have them in the manual.
> They are still in the lispref manual (and indexed, if I didn't mess that
> up), so people should be able to find them.

The names are there, but not the signatures, and there isn't even a
minimal description of the arguments.  That is too radical, IMO.

> A manual is primarily for people who are writing new code, not for
> rooting out how legacy functions work.

The manual is also for people who want to understand what the code
they look at does.

> The built-in doc system is better for that.

Then why do we have the ELisp manual at all?

I'm really unhappy about deleting that from the manual.  Would you
mind if I added back some minimal docs?

reply via email to

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