unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: joostkremers@fastmail.fm, emacs-devel@gnu.org, dgutov@yandex.ru
Subject: Re: The new keymap functions
Date: Tue, 16 Nov 2021 17:13:01 +0200	[thread overview]
Message-ID: <83h7cc16de.fsf@gnu.org> (raw)
In-Reply-To: <875yssrxfa.fsf@gnus.org> (message from Lars Ingebrigtsen on Tue,  16 Nov 2021 15:24:09 +0100)

> 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	other threads:[~2021-11-16 15:13 UTC|newest]

Thread overview: 62+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-13  6:56 The new keymap functions Lars Ingebrigtsen
2021-11-13  7:31 ` Stefan Kangas
2021-11-13  7:50   ` Lars Ingebrigtsen
2021-11-13 11:36 ` Joost Kremers
2021-11-13 12:07   ` Lars Ingebrigtsen
2021-11-15 13:01     ` Dmitry Gutov
2021-11-15 16:53       ` Lars Ingebrigtsen
2021-11-16  7:28         ` Lars Ingebrigtsen
2021-11-16 14:08           ` Eli Zaretskii
2021-11-16 14:24             ` Lars Ingebrigtsen
2021-11-16 15:13               ` Eli Zaretskii [this message]
2021-11-16 15:19                 ` Lars Ingebrigtsen
2021-11-16 17:16                   ` Eli Zaretskii
2021-11-17  7:30                     ` Lars Ingebrigtsen
2021-11-13 15:09 ` Stefan Monnier
2021-11-13 15:24   ` Lars Ingebrigtsen
2021-11-14  3:17 ` Lars Ingebrigtsen
2021-11-14  5:05 ` Phil Sainty
2021-11-14  5:14   ` Lars Ingebrigtsen
2021-11-14  7:15     ` Eli Zaretskii
2021-11-14 10:53       ` Lars Ingebrigtsen
2021-11-14 11:01         ` Lars Ingebrigtsen
2021-11-14  7:41     ` Yuri Khan
2021-11-15  4:52 ` Richard Stallman
2021-11-15  5:14   ` Lars Ingebrigtsen
2021-11-16  4:05   ` Richard Stallman
2021-11-16  7:38     ` Lars Ingebrigtsen
2021-11-16 16:25       ` [External] : " Drew Adams
2021-11-17  4:16       ` Richard Stallman
2021-11-17  7:55         ` Lars Ingebrigtsen
2021-11-17 16:06           ` [External] : " Drew Adams
2021-11-16 16:24     ` Drew Adams
2021-11-16 20:14 ` Juri Linkov
2021-11-17  4:16   ` Richard Stallman
2021-11-17  7:36   ` Lars Ingebrigtsen
2021-11-17  8:10     ` Juri Linkov
2021-11-17  9:42       ` Robert Pluim
2021-11-17 17:03         ` Juri Linkov
2021-11-18  9:15           ` Lars Ingebrigtsen
2021-11-18 10:25             ` Robert Pluim
2021-11-18 10:33               ` Lars Ingebrigtsen
2021-11-18 10:37                 ` Lars Ingebrigtsen
2021-11-18 10:54                   ` Robert Pluim
2021-11-18 10:59                     ` Lars Ingebrigtsen
2022-11-15 18:38         ` Juri Linkov
2022-11-17  7:31           ` Juri Linkov
2022-11-17  8:35             ` Robert Pluim
2022-11-17 15:04               ` Robert Pluim
2022-11-17 17:29                 ` Juri Linkov
2022-11-18  8:33                   ` Robert Pluim
2022-11-18 15:41                     ` Robert Pluim
2023-03-17 14:48                 ` Robert Pluim
2023-03-18 18:04                   ` Juri Linkov
2023-03-20  8:54                     ` Robert Pluim
2021-11-17 20:57     ` Bob Rogers
2021-11-18  3:53       ` Richard Stallman
  -- strict thread matches above, loose matches on Subject: below --
2021-11-13 18:59 xenodasein--- via Emacs development discussions.
2021-11-14  0:42 ` Lars Ingebrigtsen
2021-11-14  4:56   ` Lars Ingebrigtsen
2021-11-14 15:41     ` Stefan Monnier
2021-11-14 18:00       ` Lars Ingebrigtsen
2021-11-14 12:04   ` xenodasein--- via Emacs development discussions.

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83h7cc16de.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=dgutov@yandex.ru \
    --cc=emacs-devel@gnu.org \
    --cc=joostkremers@fastmail.fm \
    --cc=larsi@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).