Repository navigation
docs(const): link the remaining internal references in the AppType and OptionType templates (#1947) - #1953
Merged
Conversation
…d OptionType templates (#1947) - Link TransportProtocol in AppType._dispatch and the crawler's flag docstring, and AppType.get in the per-transport __canonical__ comment - Give AppType.__new__, __repr__, __str__, __int__, __eq__ and OptionType.__new__ docstrings, so their entries on reg.rst and pcapng.rst render text - Edit the vendor templates and regenerate the const modules byte-identically from the committed crawled data - Add a project test pinning the roles, the docstrings and their parity with the templates; drop the #1940 test's docstring exemption for AppType.__eq__ Closes #1947
Owner
Author
|
GOOD TO GO 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 pylint,make mypy,make isort)make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Links the internal references #1946 left in the AppType and OptionType templates, and documents the special methods whose entries rendered empty (#1947).
TransportProtocolandAppType.get()become roles; expression literals and#comments stay as they are.AppType.__new__,__repr__,__str__,__int__,__eq__andOptionType.__new__.tests/project/test_docs_internal_refs_1947_unit.pypins the roles, the docstrings and template/const docstring parity, and fails onmain. The #1940 test drops its__eq__exemption. The pinned docs build has no warnings.Closes #1947