all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Harald Hanche-Olsen <hanche@math.ntnu.no>
To: 23258@debbugs.gnu.org
Subject: bug#23258: 25.1.50; The docstring of with-eval-after-load needs improvement
Date: Sun, 10 Apr 2016 06:43:09 +0000	[thread overview]
Message-ID: <etPan.5709f5fd.7dff2e17.de73@math.ntnu.no> (raw)

The docstring for with-eval-after-load gives only a cursory description of the FILE argument. The docstring of the wrapped function eval-after-load, however, is much more comprehensive. It should either be included in the docstring of with-eval-after-load, or the docstring for with-eval-after-load should refer the reader to eval-after-load for further details. (The latter option is far better, IMO.)

As evidence of the harm done by the incomplete documentation, I offer this link:

http://emacs.stackexchange.com/q/21540/962

– Harald

In GNU Emacs 25.1.50.1 (x86_64-apple-darwin15.3.0, NS appkit-1404.34 Version 10.11.3 (Build 15D21))
 of 2016-03-16 built on frigg
Repository revision: b48197d8eda0d4fe221a128d862807d804e2ebf0
Windowing system distributor 'Apple', version 10.3.1404
Configured using:
 'configure --with-ns'


             reply	other threads:[~2016-04-10  6:43 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-10  6:43 Harald Hanche-Olsen [this message]
2016-04-10 16:17 ` bug#23258: 25.1.50; The docstring of with-eval-after-load needs improvement Eli Zaretskii
2016-04-10 16:38   ` Harald Hanche-Olsen
2016-04-10 16:44     ` Eli Zaretskii
2016-04-10 16:21 ` Drew Adams
2016-04-10 16:41   ` Eli Zaretskii
     [not found] <<etPan.5709f5fd.7dff2e17.de73@math.ntnu.no>
     [not found] ` <<83mvp1h20l.fsf@gnu.org>
2016-04-10 16:26   ` Drew Adams
2016-04-10 16:42     ` Eli Zaretskii
     [not found] ` <<6ba754ce-e37a-4334-a48c-64b55f506ed4@default>
     [not found]   ` <<83inzph0ve.fsf@gnu.org>
2016-04-10 18:14     ` Drew Adams
     [not found] <<<etPan.5709f5fd.7dff2e17.de73@math.ntnu.no>
     [not found] ` <<<83mvp1h20l.fsf@gnu.org>
     [not found]   ` <<84fc8455-9d8a-4ccd-b606-21749743cdb3@default>
     [not found]     ` <<83h9f9h0tt.fsf@gnu.org>
2016-04-10 18:49       ` Drew Adams

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

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

  git send-email \
    --in-reply-to=etPan.5709f5fd.7dff2e17.de73@math.ntnu.no \
    --to=hanche@math.ntnu.no \
    --cc=23258@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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.