unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 26888@debbugs.gnu.org
Subject: bug#26888: 25.2; doc of `with-eval-after-load'
Date: Thu, 11 May 2017 09:00:46 -0700 (PDT)	[thread overview]
Message-ID: <d29ebd9f-eecd-4ede-98f5-14016f5eb6e5@default> (raw)

1. The doc does not make clear that argument LIBRARY is evaluated or
that argument BODY is _not_ evaluated, at the time the overall sexp is
evaluated.

2. The doc string and the Elisp manual should use the same name, LIBRARY
or FILE.

3. There is lots of information about the behavior that is missing from
the doc of `with-eval-after-load' but is present in the doc of
`eval-after-load'.  They don't behave the same, but the latter makes use
of the former.  You cannot understand all of the the behavior of the
former without consulting the doc (or the code) of the latter.

We've done users a disservice by removing the doc for `eval-after-load'
from the manual and by not, at least, providing equivalent information
for `with-eval-after-load'.  We've apparently intentionally tried to
"dumb this down", but users deserve better help than this.

At the very least, the doc for `with-eval-after-load' should refer to
the more complete doc of `eval-after-load', and explain that the former
just expands to the latter after wrapping BODY in an anonymous function.


In GNU Emacs 25.2.1 (x86_64-w64-mingw32)
 of 2017-04-24
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --without-compress-install 'CFLAGS=-O2
 -static -g3''





             reply	other threads:[~2017-05-11 16:00 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-11 16:00 Drew Adams [this message]
2021-02-05 12:52 ` bug#26888: 25.2; doc of `with-eval-after-load' Lars Ingebrigtsen

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=d29ebd9f-eecd-4ede-98f5-14016f5eb6e5@default \
    --to=drew.adams@oracle.com \
    --cc=26888@debbugs.gnu.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).