* bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
@ 2017-10-27 5:18 Tim Landscheidt
2017-10-27 11:30 ` Ulf Jasper
0 siblings, 1 reply; 5+ messages in thread
From: Tim Landscheidt @ 2017-10-27 5:18 UTC (permalink / raw)
To: 29023
(newsticker) Automatic Processing says:
| […]
| In order to do so write a function which takes three arguments
| FEED
| the name of the corresponding news feed,
| TITLE
| the title of the headline,
| DESC
| the decoded description of the headline.
| and add it to ‘newsticker-new-item-functions’. […]
newsticker-new-item-functions's docstring says:
| List of functions run after a new headline has been retrieved.
| Each function is called with the following three arguments:
| FEED the name of the corresponding news feed,
| TITLE the title of the headline,
| DESC the decoded description of the headline.
However the functions "Hook samples" in newst-backend.el are
all defined as:
| […]
| (defun newsticker-new-item-functions-sample (feed item)
| […]
| (defun newsticker-download-images (feed item)
| […]
| (defun newsticker-download-enclosures (feed item)
| […]
i. e. they take two arguments, not three.
Also, there is no explicit documentation if the functions'
return values matter (AFAIUI they are ignored).
In addition, newsticker-new-item-functions's docstring re-
commends:
| […]
| See ‘newsticker-download-images’, and
| ‘newsticker-download-enclosures’ for sample functions.
| […]
It might be useful to add
newsticker-new-item-functions-*sample* to that list :-).
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
2017-10-27 5:18 bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions Tim Landscheidt
@ 2017-10-27 11:30 ` Ulf Jasper
2017-10-27 12:13 ` Eli Zaretskii
0 siblings, 1 reply; 5+ messages in thread
From: Ulf Jasper @ 2017-10-27 11:30 UTC (permalink / raw)
To: Tim Landscheidt; +Cc: 29023, 29023-done
Thanks for reporting this. Fixed on master.
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
2017-10-27 11:30 ` Ulf Jasper
@ 2017-10-27 12:13 ` Eli Zaretskii
2017-10-27 12:49 ` Ulf Jasper
0 siblings, 1 reply; 5+ messages in thread
From: Eli Zaretskii @ 2017-10-27 12:13 UTC (permalink / raw)
To: Ulf Jasper; +Cc: 29023, tim
> From: Ulf Jasper <ulf.jasper@web.de>
> Date: Fri, 27 Oct 2017 13:30:26 +0200
> Cc: 29023@debbugs.gnu.org, 29023-done@debbugs.gnu.org
>
> Thanks for reporting this. Fixed on master.
Thanks, but I think this should have been fixed on the release branch
instead. Could you please cherry-pick your commit to the emacs-26
branch?
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
2017-10-27 12:13 ` Eli Zaretskii
@ 2017-10-27 12:49 ` Ulf Jasper
2017-10-27 13:24 ` Eli Zaretskii
0 siblings, 1 reply; 5+ messages in thread
From: Ulf Jasper @ 2017-10-27 12:49 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 29023, tim
Am 27.10.2017 um 15:13 (+0300) schrieb Eli Zaretskii:
> Thanks, but I think this should have been fixed on the release branch
> instead. Could you please cherry-pick your commit to the emacs-26
> branch?
Done.
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
2017-10-27 12:49 ` Ulf Jasper
@ 2017-10-27 13:24 ` Eli Zaretskii
0 siblings, 0 replies; 5+ messages in thread
From: Eli Zaretskii @ 2017-10-27 13:24 UTC (permalink / raw)
To: Ulf Jasper; +Cc: 29023, tim
> From: Ulf Jasper <ulf.jasper@web.de>
> Cc: tim@tim-landscheidt.de, 29023@debbugs.gnu.org
> Date: Fri, 27 Oct 2017 14:49:10 +0200
>
> Am 27.10.2017 um 15:13 (+0300) schrieb Eli Zaretskii:
>
> > Thanks, but I think this should have been fixed on the release branch
> > instead. Could you please cherry-pick your commit to the emacs-26
> > branch?
>
> Done.
Thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2017-10-27 13:24 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-10-27 5:18 bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions Tim Landscheidt
2017-10-27 11:30 ` Ulf Jasper
2017-10-27 12:13 ` Eli Zaretskii
2017-10-27 12:49 ` Ulf Jasper
2017-10-27 13:24 ` Eli Zaretskii
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).