[debbugs-tracker] bug#29023: closed (25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions)

[GNU bug Tracking System]

Your message dated Fri, 27 Oct 2017 13:30:26 +0200
with message-id <address@hidden>
and subject line Re: bug#29023: 25.3; newsticker: Inconsistent documentation of 
newsticker-new-item-functions
has caused the debbugs.gnu.org bug report #29023,
regarding 25.3; newsticker: Inconsistent documentation of 
newsticker-new-item-functions
to be marked as done.

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


-- 
29023: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=29023
GNU Bug Tracking System
Contact address@hidden with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
>
>
>
>
> Date: 
>
> Fri, 27 Oct 2017 05:18:41 +0000
>
>
>
>
> User-agent: 
>
> Gnus/5.13 (Gnus v5.13) Emacs/25.3 (gnu/linux)
>
>
>
>
> (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 :-).
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#29023: 25.3; newsticker: Inconsistent documentation of newsticker-new-item-functions
>
>
>
>
> Date: 
>
> Fri, 27 Oct 2017 13:30:26 +0200
>
>
>
>
> User-agent: 
>
> Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)
>
>
>
>
> Thanks for reporting this.  Fixed on master.
>
>
> --- End Message ---