Docs + changelog for #317 / #333.

Closes #317.
lemon24 · May 25, 2024 · 57a90a6 · 57a90a6
1 parent 2b569d2
commit 57a90a6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -11,6 +11,13 @@ Version 3.13
 
 Unreleased
 
+* Make it possible to re-run the :mod:`~reader.plugins.mark_as_read` plugin
+  for existing entries.
+  Thanks to `Michael Han`_ for the pull request.
+  (:issue:`317`)
+
+.. _Michael Han: https://github.com/Sakunam
+
 
 Version 3.12
 ------------

diff --git a/src/reader/plugins/mark_as_read.py b/src/reader/plugins/mark_as_read.py
@@ -16,6 +16,11 @@
         "title": ["first-regex", "second-regex"]
     }
 
+By default, this plugin runs only for newly-added entries.
+To run it for the existing entries of a feed,
+add the ``.reader.mark-as-read.once`` tag to the feed;
+the plugin will run on the next feed update, and remove the tag afterwards.
+
 
 .. versionchanged:: 2.4
     Explicitly mark matching entries as unimportant.
@@ -32,6 +37,9 @@
     ``important = False`` is enough to mark an entry as unimportant.
     Old unimportant entries will be migrated automatically.
 
+.. versionchanged:: 3.13
+    Make it possible to re-run the plugin for existing entries.
+
 
 .. todo::