GNU bug report logs - #29023
25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 29023 in the body.
You can then email your comments to 29023 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tim Landscheidt <tim <at> tim-landscheidt.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.3; newsticker: Inconsistent documentation of
 newsticker-new-item-functions
Date: Fri, 27 Oct 2017 05:18:41 +0000

(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 :-).

Message #8 received at 29023 <at> debbugs.gnu.org (full text, mbox):

From: Ulf Jasper <ulf.jasper <at> web.de>
To: Tim Landscheidt <tim <at> tim-landscheidt.de>
Cc: 29023 <at> debbugs.gnu.org, 29023-done <at> debbugs.gnu.org
Subject: Re: bug#29023: 25.3; newsticker: Inconsistent documentation of
 newsticker-new-item-functions
Date: Fri, 27 Oct 2017 13:30:26 +0200

Thanks for reporting this.  Fixed on master.

Message #16 received at 29023 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Ulf Jasper <ulf.jasper <at> web.de>
Cc: 29023 <at> debbugs.gnu.org, tim <at> tim-landscheidt.de
Subject: Re: bug#29023: 25.3; newsticker: Inconsistent documentation of
 newsticker-new-item-functions
Date: Fri, 27 Oct 2017 15:13:40 +0300

> From: Ulf Jasper <ulf.jasper <at> web.de>
> Date: Fri, 27 Oct 2017 13:30:26 +0200
> Cc: 29023 <at> debbugs.gnu.org, 29023-done <at> 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?

Message #19 received at 29023 <at> debbugs.gnu.org (full text, mbox):

From: Ulf Jasper <ulf.jasper <at> web.de>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 29023 <at> debbugs.gnu.org, tim <at> tim-landscheidt.de
Subject: Re: bug#29023: 25.3; newsticker: Inconsistent documentation of
 newsticker-new-item-functions
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.

Message #22 received at 29023 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Ulf Jasper <ulf.jasper <at> web.de>
Cc: 29023 <at> debbugs.gnu.org, tim <at> tim-landscheidt.de
Subject: Re: bug#29023: 25.3; newsticker: Inconsistent documentation of
 newsticker-new-item-functions
Date: Fri, 27 Oct 2017 16:24:28 +0300

> From: Ulf Jasper <ulf.jasper <at> web.de>
> Cc: tim <at> tim-landscheidt.de,  29023 <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.