Repository navigation
docs: link library-internal references and document the missing public classes (#1940) - #1946
Conversation
…c classes (#1940) - Convert library-internal names written as double-backtick literals in rendered prose and docstrings to Python-domain roles; literals that mean a concept, a layer, a wire field, an extra or a historical name stay literals - Document CommandType, ConformanceRequirement, ResponseKind, GroupingInformation, the HTTP/2 Settings data model, OptionEnumField and OptionAreaField - Give every private helper and special method that rendered text names an entry, with a docstring where it had none (const docstrings in their vendor templates), and repoint or demote the roles those docstrings carry - Read an enumeration's own __new__ in autodoc, so :special-members: __new__ documents the registry row constructor rather than the enum machinery's - Add a project test pinning the entries, the helpers and a curated set of the converted references; update the tests that pinned the old literals Closes #1940
|
NEEDS CHANGES at |
…wording (#1940) - Point the ipv6_ext page's Internet._lookup_next_layer role at ProtocolBase._lookup_next_layer, where the method is documented, as the module docstring already does - Restate the #1940 test's docstrings and comments, and the conf.py getter's docstring, as standing facts rather than as what changed Refs #1940
|
GOOD TO GO at |
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
Turns library-internal names written as literals in rendered prose into roles, such as
FrameType.FlagsandAppType.get. It also documents what they point at: the missing public classes (CommandType,ConformanceRequirement,ResponseKind,GroupingInformation,Settings,OptionEnumField) and, per the ruling on #1940, the private helpers and special methods that rendered text names. Concepts, layer names, wire fields, extras and historical names stay literals.docs/source/conf.pygains an attribute getter so:special-members: __new__documents an enum's own__new__rather than the enum machinery's. Const docstrings go through their vendor templates. The AppType and OptionType files are left to #1945.tests/project/test_docs_internal_refs_1940_unit.pypins the entries and a curated set of converted references, and fails without the change. The docs build has no warnings.Closes #1940