Clean up changelog for #332

CHANGES.rst

@@ -11,28 +11,20 @@ Version 3.13
 
 Unreleased
 
-* Update entries whenever their :attr:`~Entry.updated` changes,
-  don't compare the values. (:issue:`332`)
-* Add :attr:`Feed.update_after` and :attr:`Feed.last_retrieved`. (:issue:`332`)
-* The ``new`` filter of :meth:`~Reader.update_feeds()` etc. considers
-  a feed as new if it was never retrieved (:attr:`~Feed.last_retrieved`),
-  not if it was never updated successfully (:attr:`~Feed.last_updated`). (:issue:`332`)
-* Add :meth:`~Reader.update_feeds()`, :meth:`~Reader.get_feeds()`, etc.
-  argument ``scheduled`` to allow updating only feeds scheduled to be updated.
-  See :ref:`scheduled` for details.
+* Allow different feed update intervals; see :ref:`scheduled` for details.
   (:issue:`332`)
 
-  .. FIXME: versionchanged on update_feeds() etc.
+  * Add ``scheduled`` argument to :meth:`~Reader.update_feeds()`,
+    :meth:`~Reader.get_feeds()`, etc.
 
-* Add ``--scheduled`` flag to the ``update`` command. (:issue:`332`)
-* Group mutually-exclusive attributes of :class:`~.FeedUpdateIntent`
-  into its :attr:`~.FeedUpdateIntent.value` union attribute. (:issue:`332`)
-* New and improved :ref:`update` user guide section.
+  * Add :attr:`Feed.update_after` and :attr:`~Feed.last_retrieved` attributes.
+
+  * The ``new`` filter of :meth:`~Reader.update_feeds()` etc. considers
+    a feed new if it was never retrieved (:attr:`~Feed.last_retrieved`),
+    not if it was never updated successfully (:attr:`~Feed.last_updated`).
 
-* The :mod:`~reader._plugins.cli_status` plugin now
-  records the output of multiple runs instead of just the last one,
-  with output from the same hour grouped in a single entry,
-  up to 24 entries (hours). (:issue:`332`)
+  * Update an entry whenever its :attr:`~Entry.updated` changes
+    (don't require it to be newer).
 
 * Fix bug introduced in `version 3.12 <Version 3.12_>`_ causing an assertion error
   when there are multiple entries with the same id in the same feed,
@@ -43,10 +35,21 @@ Unreleased
 
   * Fix assertion error when an entry is deleted while being updated.
 
-* Make it possible to re-run the :mod:`~reader.plugins.mark_as_read` plugin
-  for existing entries.
+* Allow re-running the :mod:`~reader.plugins.mark_as_read` plugin for existing entries.
   Thanks to `Michael Han`_ for the pull request.
   (:issue:`317`)
+
+* Other changes for scheduled updates. (:issue:`332`)
+
+  * Add ``--scheduled`` flag to the ``update`` command.
+  * The :mod:`~reader._plugins.cli_status` plugin now
+    records the output of multiple runs instead of just the last one,
+    with output from the same hour grouped in a single entry,
+    up to 24 entries/hours.
+  * Group mutually-exclusive attributes of :class:`~.FeedUpdateIntent`
+    into a new :attr:`~.FeedUpdateIntent.value` union attribute.
+
+* New and improved :ref:`update` user guide section.
 * Rename ``update --new-only`` CLI flag to ``--new``;
   ``--new-only`` remains available as an alias.
   (:issue:`334`)

docs/dev.rst

@@ -600,6 +600,8 @@ Updating entries based on a hash of their content (regardless of ``updated``):
 
 Decision to ignore feed.updated when updating feeds: :issue:`231`.
 
+:ref:`scheduled` (initial design + postponed features): :issue:`322`.
+
 
 .. _deleting entries:
 

docs/guide.rst

@@ -291,7 +291,6 @@ the update will occur any time in the first 6 hours of the interval.
     If you want feeds to be updated no more often than e.g. every hour,
     you have to run :meth:`update_feeds(scheduled=True) <Reader.update_feeds>`
     no more often than every hour.
-
     Please :ref:`open an issue <issues>` if you need a minimum update interval.
 
 In a future version of *reader*,

src/reader/core.py

@@ -604,6 +604,10 @@ def get_feeds(
         .. versionadded:: 3.13
             The ``scheduled`` keyword argument.
 
+        .. versionchanged:: 3.13
+            ``new`` uses :attr:`~Feed.last_retrieved`
+            instead of :attr:`~Feed.last_updated`.
+
         """
         filter = FeedFilter.from_args(
             self._now(), feed, tags, broken, updates_enabled, new, scheduled
@@ -704,6 +708,10 @@ def get_feed_counts(
         .. versionadded:: 3.13
             The ``scheduled`` keyword argument.
 
+        .. versionchanged:: 3.13
+            ``new`` uses :attr:`~Feed.last_retrieved`
+            instead of :attr:`~Feed.last_updated`.
+
         """
         filter = FeedFilter.from_args(
             self._now(), feed, tags, broken, updates_enabled, new, scheduled
@@ -855,6 +863,10 @@ def update_feeds(
         .. versionadded:: 3.13
             The ``scheduled`` keyword argument.
 
+        .. versionchanged:: 3.13
+            ``new`` uses :attr:`~Feed.last_retrieved`
+            instead of :attr:`~Feed.last_updated`.
+
         """
         hook_errors = self._update_hooks.group("some hooks failed")
         try:
@@ -994,6 +1006,10 @@ def update_feeds_iter(
         .. versionadded:: 3.13
             The ``scheduled`` keyword argument.
 
+        .. versionchanged:: 3.13
+            ``new`` uses :attr:`~Feed.last_retrieved`
+            instead of :attr:`~Feed.last_updated`.
+
         """
         now = self._now()
         filter = FeedFilter.from_args(