Skip to content

Commit 130a0ce

Browse files
committed
docs: fix Sphinx warnings.
1 parent 317e425 commit 130a0ce

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

CHANGES.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ Released 2024-07-23
304304
* Fix bug in the :mod:`~reader.plugins.entry_dedupe` plugin causing entries
305305
to flip-flop if there were multiple *new* duplicates of the same issue
306306
(on the first update, one entry remains, on the second update, the other);
307-
related to the bug fixed in `version 3.2 <Version 3.2_>`_.
307+
related to the bug fixed in `version 3.2 <Version 3.2_>`__.
308308
(:issue:`340`)
309309

310310
* :mod:`~reader._plugins.enclosure_tags` plugin improvements. (:issue:`344`)
@@ -347,7 +347,7 @@ Released 2024-06-19
347347
* Update an entry whenever its :attr:`~Entry.updated` changes
348348
(don't require it to be newer).
349349

350-
* Fix bug introduced in `version 3.12 <Version 3.12_>`_ causing an assertion error
350+
* Fix bug introduced in `version 3.12 <Version 3.12_>`__ causing an assertion error
351351
when there are multiple entries with the same id in the same feed,
352352
or when parallel :meth:`~Reader.update_feeds` calls add the same entry.
353353
The fix restores the pre-3.12 first-entry-wins / last-write-wins behavior.
@@ -498,7 +498,7 @@ Released 2023-08-20
498498

499499
* Add werkzeug dependency,
500500
instead of vendoring selected :mod:`werkzeug.http` utilities.
501-
* Rework lazy imports introduced in `version 3.3 <Version 3.3_>`_.
501+
* Rework lazy imports introduced in `version 3.3 <Version 3.3_>`__.
502502
(:issue:`316`)
503503
* Make :mod:`reader._parser` a package, and move parsing-related modules into it.
504504
(:issue:`316`)
@@ -559,7 +559,7 @@ Released 2023-03-19
559559
so one can express "explicitly unimportant" (*don't care*)
560560
by setting it to :const:`False`.
561561
This replaces the semantics for *don't care* introduced
562-
in `version 2.2 <Version 2.2_>`_.
562+
in `version 2.2 <Version 2.2_>`__.
563563
(:issue:`254`)
564564

565565
.. warning::

src/reader/_types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1335,7 +1335,7 @@ def changes(self) -> ChangeTrackerType:
13351335
class ChangeTrackerType(Protocol): # pragma: no cover
13361336
"""Storage API used to keep the full-text search index in sync.
13371337
1338-
----
1338+
.. rubric:: Sync model
13391339
13401340
The sync model works as follows.
13411341
@@ -1381,7 +1381,7 @@ class ChangeTrackerType(Protocol): # pragma: no cover
13811381
The model was validated using property-based testing
13821382
in `this gist <https://gist.github.com/lemon24/558955ad82ba2e4f50c0184c630c668c>`_.
13831383
1384-
----
1384+
.. rubric:: API considerations
13851385
13861386
The entry sequence is exposed as :attr:`.Entry._sequence`,
13871387
and should change when

0 commit comments

Comments
 (0)