diff options
| author | Ulf Jasper | 2017-10-27 13:26:06 +0200 |
|---|---|---|
| committer | Ulf Jasper | 2017-10-27 13:26:06 +0200 |
| commit | cb185dfd0c227dda14de25d450d0d684e91cafb3 (patch) | |
| tree | 2a8dda2edbb88f84c9787ec6567e31cb72217f6c /doc | |
| parent | c015f935e06cf2ba3ef8f69f5ef086fc1e51c9d1 (diff) | |
| download | emacs-cb185dfd0c227dda14de25d450d0d684e91cafb3.tar.gz emacs-cb185dfd0c227dda14de25d450d0d684e91cafb3.zip | |
Fix documentation of `newsticker-new-item-functions' (bug#29023).
* lisp/net/newst-backend.el (newsticker-new-item-functions),
(newsticker-new-item-functions-sample),
(newsticker-download-enclosures): Fix docstring, rename
variable feed to feedname (bug#29023).
* doc/misc/newsticker.texi (Automatic Processing)
(Automatic Processing): Fix documentation of
`newsticker-new-item-functions' (bug#29023).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/newsticker.texi | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/doc/misc/newsticker.texi b/doc/misc/newsticker.texi index 6928baab1fa..f60ffba358d 100644 --- a/doc/misc/newsticker.texi +++ b/doc/misc/newsticker.texi | |||
| @@ -440,20 +440,18 @@ headlines. Instead of reading headlines yourself you can tell | |||
| 440 | Newsticker to do that for you. | 440 | Newsticker to do that for you. |
| 441 | 441 | ||
| 442 | @vindex newsticker-new-item-functions | 442 | @vindex newsticker-new-item-functions |
| 443 | In order to do so write a function which takes three arguments | 443 | In order to do so write a function which takes two arguments |
| 444 | 444 | ||
| 445 | @table @var | 445 | @table @var |
| 446 | @item FEED | 446 | @item FEEDNAME |
| 447 | the name of the corresponding news feed, | 447 | the name of the corresponding news feed, |
| 448 | @item TITLE | 448 | @item ITEM |
| 449 | the title of the headline, | 449 | the decoded headline. |
| 450 | @item DESC | ||
| 451 | the decoded description of the headline. | ||
| 452 | @end table | 450 | @end table |
| 453 | 451 | ||
| 454 | and add it to @code{newsticker-new-item-functions}. Each function | 452 | and add it to @code{newsticker-new-item-functions}. Each function |
| 455 | contained in this list is called once for each new headline. | 453 | contained in this list is called once for each new headline. |
| 456 | Depending on the feed, the title and the description of a headline you | 454 | Depending on the feed name and the contents of the new headline you |
| 457 | can | 455 | can |
| 458 | 456 | ||
| 459 | @itemize | 457 | @itemize |
| @@ -463,7 +461,7 @@ descriptions (for which a function already exists, see | |||
| 463 | @code{newsticker-download-images}), | 461 | @code{newsticker-download-images}), |
| 464 | @item | 462 | @item |
| 465 | automatically save enclosed audio and video files (for which another | 463 | automatically save enclosed audio and video files (for which another |
| 466 | function exists as well, see @code{newsticker-download-images}), | 464 | function exists as well, see @code{newsticker-download-enclosures}), |
| 467 | @item | 465 | @item |
| 468 | flash the screen while playing some sound, | 466 | flash the screen while playing some sound, |
| 469 | @item | 467 | @item |