You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: say which distribution a bare pcap module reference means #1948
pcap is written as a bare literal at most of its mentions, mostly in pcapkit/foundation/engines/{pcap_ct,pypcap,_pcap_backend}.py, plus extraction.py, the engines pages, index.rst and ext.rst. Both PyPCAP and pcap-ct install that same top-level pcap module. The docs say so in one place, docs/source/pcapkit/foundation/engines/3rdparty.rst:188, and a reader meeting a bare pcap elsewhere cannot tell which distribution it means.
A literal footnote does not fit: one defined in rst_epilog is appended to every page and warns as unreferenced wherever it goes unused. Two options:
A glossary term. Add a pcap entry to a glossary that names both distributions, and write each mention as :term:`pcap`. Each mention links to the glossary entry, so it reads like option 1 but adds a glossary page.
I'd take option 1: it reuses an existing mechanism and adds no new page. Mentions that name a distribution (pip install pypcap, the PyPCAP/PCAP_CT extras) stay as they are.
Going with option 1: a pcap-module label on the existing note and an epilog |pcap|_ link at each bare mention. Most of these files are also edited by #1946, so the work is stacked on that branch and the PR opens once #1946 merges. A wider glossary is left out of this issue; it can get its own once there are terms that need one.
Activity
JarryShaw commentedon Oct 19, 2026
option 1
JarryShaw commentedon Oct 19, 2026
but if necessary, we can create some glossary terms for the documentation with other terms and context in the docs.
JarryShaw commentedon Oct 19, 2026
Going with option 1: a
pcap-modulelabel on the existing note and an epilog|pcap|_link at each bare mention. Most of these files are also edited by #1946, so the work is stacked on that branch and the PR opens once #1946 merges. A wider glossary is left out of this issue; it can get its own once there are terms that need one.docs: link bare pcap module mentions to the PyPCAP/pcap-ct note (#1948)
docs: keep the pcap module link safe on non-HTML builders (#1948)
test(docs): state the latex NoUri case as a fact (#1948)