From 4e378fee07175ab1464b628e4c02507b30957c7c Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 25 Sep 2024 17:38:50 +0300 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- pep_sphinx_extensions/pep_zero_generator/writer.py | 6 +++++- peps/contents.rst | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/pep_sphinx_extensions/pep_zero_generator/writer.py b/pep_sphinx_extensions/pep_zero_generator/writer.py index 123d42a243d..ffd23275d73 100644 --- a/pep_sphinx_extensions/pep_zero_generator/writer.py +++ b/pep_sphinx_extensions/pep_zero_generator/writer.py @@ -133,6 +133,7 @@ def emit_pep_category(self, category: str, peps: list[PEP]) -> None: self.emit_newline() def write_numerical_index(self, peps: list[PEP]) -> str: + """Write PEPs by number.""" self.emit_text(".. _numerical-index:") self.emit_newline() @@ -190,7 +191,10 @@ def write_pep0( # PEPs by number if is_pep0: self.emit_title("Numerical Index") - self.emit_text("All PEPs :ref:`sorted by number `.") + self.emit_text( + "The :doc:`numerical index ` contains " + "a table of all PEPs :ref:`sorted by number `." + ) self.emit_newline() # PEPs by category diff --git a/peps/contents.rst b/peps/contents.rst index 1878d5db990..0dc1f8e5817 100644 --- a/peps/contents.rst +++ b/peps/contents.rst @@ -15,6 +15,6 @@ This is an internal Sphinx page; please go to the :doc:`PEP Index `. :caption: PEP Table of Contents (needed for Sphinx): api/* + topic/* numerical pep-* - topic/*