Repository navigation
docs(api): document context, IPX._next_exthdr_depth and the pcapng schema helpers (#2234) - #2251
Merged
Merged
Conversation
…hema helpers (#2234) Problem: ProtocolBase.context, the IPX._next_exthdr_depth override of a documented hook, and held_body, FlagsField and PACKET_FLAGS in the pcapng schema module had docstrings but no API entry. Fix: list context on the Protocol autoclass and in the ProtocolBase property group, add _next_exthdr_depth to the IPX autoclass, and add the three pcapng entries beside their siblings. _held_octets and _secrets_cut stay undocumented: no rendered text names them, so they are recipe. Test: tests/project/test_docs_missing_directives_2234_unit.py pins each entry and the object it names; it fails on origin/main.
Owner
Author
|
Review: GOOD TO GO at
|
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge at
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Closes #2234. These members had docstrings but no directive, so they rendered on no page.
protocol.rst:.. autoproperty:: contexton theProtocolautoclass, andcontextin theProtocolBasepy:propertygroup.ipx.rst:.. automethod:: _next_exthdr_depth, the fix(ipx): the next layer is chosen by IPX Packet Type, looked up as an IP protocol number #2169 override, which overrides a hookinternet.rstdocuments.pcapng.rst:PACKET_FLAGS(autodata),FlagsFieldandheld_body._held_octetsand_secrets_cut. No rendered text names them, so they are recipe, not contract.contextinPCAPNG'sversionchangednote touchespcapng.py, so it waits for fix(ethernet,pcapng): reject a non-string MAC or EUI address (#2222) #2232.tests/project/test_docs_missing_directives_2234_unit.pychecks each directive is in its block. It gives 6 failed onorigin/main.sphinx-build -b htmlin the pinned docs venv ran with no Sphinx warnings, and all five anchors render.test_docs_*andtest_documentation_claimswith Sphinx give 156 passed.