From: Tim Landscheidt <tim@tim-landscheidt.de>
To: 29023@debbugs.gnu.org
Subject: bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
Date: Fri, 27 Oct 2017 05:18:41 +0000 [thread overview]
Message-ID: <8760b1p3ri.fsf@passepartout.tim-landscheidt.de> (raw)
(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 :-).
next reply other threads:[~2017-10-27 5:18 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-27 5:18 Tim Landscheidt [this message]
2017-10-27 11:30 ` bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions Ulf Jasper
2017-10-27 12:13 ` Eli Zaretskii
2017-10-27 12:49 ` Ulf Jasper
2017-10-27 13:24 ` Eli Zaretskii
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=8760b1p3ri.fsf@passepartout.tim-landscheidt.de \
--to=tim@tim-landscheidt.de \
--cc=29023@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).