From 173d9657ff5573aeb7734fa27e967b0e7696efaf Mon Sep 17 00:00:00 2001 From: Jarry Shaw Date: Tue, 15 Sep 2026 14:41:13 -0400 Subject: [PATCH 1/2] README: render the callouts on GitHub, not just in Sphinx GitHub renders reStructuredText through plain docutils, which knows the `note`/`important` directives but emits them as a class-less `
` containing the label as an ordinary paragraph. Fetched from the live page rather than guessed at:

Important

The all extra deliberately does not ... So all three admonitions showed up as the bare word "Note" or "Important" stranded on its own line above the text, with no callout box and nothing marking them as asides. Zero elements carrying an `admonition` class reached the page. Rewritten as blockquotes with a bold lead, which GitHub renders with its left bar. This is not a new convention for the file -- the README already used exactly this shape in two other places, so the three directives were the odd ones out. Nothing else in the README needs it: the eight `code-block:: shell` blocks all highlight correctly (docutils 0.22 registers `code-block`), the `list-table` becomes a real table, and all ten named hyperlink targets resolve. Verified by counting the rendered elements, not by eye. README.rst is not included in the Sphinx tree, so this trades nothing on the docs side. --- README.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 4dabd8081..d290b3ae8 100644 --- a/README.rst +++ b/README.rst @@ -145,9 +145,9 @@ host, capture and iteration count as the existing rows. Installation ------------ -.. note:: +.. - ``pcapkit`` supports Python versions **since 3.6**. + **Note** -- ``pcapkit`` supports Python versions **since 3.6**. Simply run the following to install the current version from PyPI: @@ -209,9 +209,10 @@ plug-in functions, you may want to install the optional ones: # or to do this explicitly pip install pypcapkit dpkt scapy pyshark pypcapfile -.. important:: +.. - The ``all`` extra deliberately does **not** include ``pypcap``. Everything + **Important** -- The ``all`` extra deliberately does **not** include + ``pypcap``. Everything else in ``all`` is a pure-Python wheel, whereas ``pypcap`` compiles a C extension; pulling it into ``all`` would demand a working compiler and the `libpcap`_ development files from everyone installing ``pypcapkit[all]``. @@ -261,9 +262,10 @@ Three of the engines need something beyond a ``pip install``: this but no release carries the fix yet, so this engine also requires Python **3.11 or older** until 0.12.1 is published. -.. note:: +.. - ``pcapkit`` itself, and its ``default``, ``dpkt`` and ``scapy`` engines, work + **Note** -- ``pcapkit`` itself, and its ``default``, ``dpkt`` and ``scapy`` + engines, work fine on current Python versions. Only the three engines above carry these extra constraints, and asking for an engine whose package is unavailable emits a warning and falls back to ``pcapkit``'s own parser rather than From af150bfb9e100a40cfa0fed2b6e2185bc0e79225 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 15 Sep 2026 19:00:48 +0000 Subject: [PATCH 2/2] README: remove stray RST comment markers Co-authored-by: JarryShaw <15666417+JarryShaw@users.noreply.github.com> --- README.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.rst b/README.rst index d290b3ae8..1d4cd1cc5 100644 --- a/README.rst +++ b/README.rst @@ -145,8 +145,6 @@ host, capture and iteration count as the existing rows. Installation ------------ -.. - **Note** -- ``pcapkit`` supports Python versions **since 3.6**. Simply run the following to install the current version from PyPI: @@ -209,8 +207,6 @@ plug-in functions, you may want to install the optional ones: # or to do this explicitly pip install pypcapkit dpkt scapy pyshark pypcapfile -.. - **Important** -- The ``all`` extra deliberately does **not** include ``pypcap``. Everything else in ``all`` is a pure-Python wheel, whereas ``pypcap`` compiles a C @@ -262,8 +258,6 @@ Three of the engines need something beyond a ``pip install``: this but no release carries the fix yet, so this engine also requires Python **3.11 or older** until 0.12.1 is published. -.. - **Note** -- ``pcapkit`` itself, and its ``default``, ``dpkt`` and ``scapy`` engines, work fine on current Python versions. Only the three engines above carry these