emacs-bug-tracker
[Top][All Lists]
Advanced

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

[debbugs-tracker] bug#23258: closed (25.1.50; The docstring of with-eval


From: GNU bug Tracking System
Subject: [debbugs-tracker] bug#23258: closed (25.1.50; The docstring of with-eval-after-load needs improvement)
Date: Sun, 10 Apr 2016 16:18:02 +0000

Your message dated Sun, 10 Apr 2016 19:17:14 +0300
with message-id <address@hidden>
and subject line Re: bug#23258: 25.1.50; The docstring of with-eval-after-load 
needs improvement
has caused the debbugs.gnu.org bug report #23258,
regarding 25.1.50; The docstring of with-eval-after-load needs improvement
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
23258: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=23258
GNU Bug Tracking System
Contact address@hidden with problems
--- Begin Message --- Subject: 25.1.50; The docstring of with-eval-after-load needs improvement Date: Sun, 10 Apr 2016 06:43:09 +0000
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'


--- End Message ---
--- Begin Message --- Subject: Re: bug#23258: 25.1.50; The docstring of with-eval-after-load needs improvement Date: Sun, 10 Apr 2016 19:17:14 +0300
> From: Harald Hanche-Olsen <address@hidden>
> Date: Sun, 10 Apr 2016 06:43:09 +0000
> 
> 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.)

Fixed.

For such simple bugs, I'd encourage people to submit patches rather
than just tell how to fix the problem.  Thanks in advance.


--- End Message ---

reply via email to

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