Repository navigation
docs: render #771's two unregistered-member helpers in numbers.rst (#780) - #781
Conversation
) * Add `.. autofunction::` stubs for `_rebuild_unregistered_member` and `_reduce_unregistered_member` under the existing Internal Definitions heading. Both carry full `Args:`/`Returns:` docstrings that went unrendered because the file listed no stubs for them. This follows the `_purge` precedent in `3rdparty.rst` rather than a blanket `:private-members:` toggle, which stays commented out repo-wide. * Promote the two prose references to `_rebuild_unregistered_member` from double backticks to `:func:` roles, now that the stubs make them resolve. They were literals deliberately, to avoid a dangling cross-reference while the stubs were absent. Docs build: 53 warnings before, 53 after -- byte-for-byte identical after sorting. Both stubs render with their own anchors and the two prose references resolve to internal links.
|
Cross-review at The claim I could not check cheaply is confirmed, and confirmed the hard way. Both trees built separately with The mechanism claim behind that measurement also holds, which matters because it decides whether the warning diff means anything: Both stubs render. Own One claim narrower than it reads, not a defect. The author justified placement as "the file follows source order". Also swept: no stub exists anywhere under Eight CI legs still outstanding on this head (19 success, 3 expected skips, 0 failures). This is a review verdict, not a merge signal. |
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeAdded a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — changelog centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
Closes #780.
#771 added
_rebuild_unregistered_memberand_reduce_unregistered_membertopcapkit/corekit/fields/numbers.py. Both carry fullArgs:/Returns:docstrings, butnumbers.rstlisted no stubs for them, so neither was rendered... autofunction::entries under the existing Internal Definitions heading, after theNumberFieldautoclass (source order). Individual stubs follow the_purgeprecedent atdocs/source/pcapkit/foundation/engines/3rdparty.rst:481;:private-members:stays commented out repo-wide.:func:— the only two convertible references are both to_rebuild_unregistered_member, atnumbers.py:680(inEnumField._unregistered_member'sNote:) andnumbers.py:804(in_reduce_unregistered_member'sReturns:). Relative roles, matching_pcap_backend.py:198's ``:func:_purge```. Everything else still in double backticks is an enum/object internal with no stub here (reduce_ex`, `value`, `name`, `new`, `value2member_map`, `missing` — the last is in `conf.py`'s `exclude-members`).Verification — full
sphinx-build -b html -E, Sphinx 9.1.0 / Python 3.14.7, with the resolved package root asserted in-process as this tree (the venv's editable install otherwise wins overcwd). 53 warnings before, 53 after — byte-for-byte identical after sorting, so no new warning and noduplicate object descriptionfor either stub. Both stubs render their ownid=anchor andArgs:/Returns:body; the two prose references resolve to internal links (xref py py-func), with zero plain literals left for that name.