Repository navigation
docs: signature defaults render by value, so sys.byteorder shows the build host's 'little' #1859
Description
Every byteorder=sys.byteorder default renders as 'little', the build host's value. Sites:
protocols/link/loopback.py:218dumpkit/pcap.py:115,163interface/core.py:81,230,interface/misc.py:78protocols/misc/pcap/header.py:176,348,protocols/misc/pcapng.py:4364foundation/extraction.py:1117,foundation/traceflow/traceflow.py:407
The same mechanism prints default=<pcapkit.corekit.sentinels.NoValueType object> and callback=<function NumberField.<lambda>> on the corekit/fields pages.
Root cause: autodoc renders a default's repr() unless autodoc_preserve_defaults is on, and docs/source/conf.py leaves it off.
Fix: set autodoc_preserve_defaults = True. A trial build added no warnings, and each changed default became its source text (sys.byteorder, NO_VALUE, NULL, io.DEFAULT_BUFFER_SIZE, the lambda). It also exposes private import aliases as default text (Enum_LinkType.NULL, Enum_Frame.DATA), which should be reviewed in the build diff. Verify after #1856, which changes signature rendering.
Activity
JarryShaw commentedon Oct 16, 2026
Blocked until #1856 merges. That PR bumps sphinx-autodoc-typehints, which changes how signatures render, and it edits
docs/source/conf.py, which this fix also edits.JarryShaw commentedon Oct 17, 2026
Started on top of #1877, the PR for #1856, so the
conf.pyedits don't conflict. One worker is taking #1858–#1863 together, since every fix goes throughconf.py.docs(conf): fix class signatures, defaults, aenum names, table ids an…
docs(conf): fix class signatures, defaults, aenum names, table ids an…
docs(conf): fix class signatures, defaults, aenum names, table ids an…
docs(conf): fix class signatures, defaults, aenum names, table ids an…