Repository navigation
docs(const): document the get overrides instead of hiding them (#1921) - #1935
Conversation
- Drop `:meta private:` from the `get` overrides of `Command`, `Method`, `OptionType`, `TransportProtocol` and `AppType`, in the vendor templates and the const modules regenerated from them, so `:meth:`get`` links again - Replace each "Backport support for original codes." summary with the lookup it performs, and state what `get` returns on a miss - Give `OptionType.get` a contract: namespace overlay for codes, case-sensitive names, and what `default` is for - Add a project test that no override, template or `:meth:` reference to one is marked private Closes #1921
|
NEEDS CHANGES at |
- Say that `AppType.get` names a miss after the label of the IANA span holding the port, whatever that label is, or `unknown` when no span holds it, in the template and the regenerated const module - State the #1921 test's prose as what it checks, without timed context - Pin known references among the `:meth:` hits, so a reference that stops resolving fails the test Closes #1921
|
GOOD TO GO at |
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 — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657
docs— documentation onlyPer the ruling on #1921, this drops
:meta private:from thegetoverrides ofCommand,Method,OptionType,TransportProtocolandAppType. Every:meth:get`` reference on the ftp, http, pcapng and reg pages now links.The const modules are regenerated from the edited templates, reusing the crawled parts already committed, and are byte-identical to the rendered output. Each summary now states how the lookup handles case and what a miss returns.
OptionType.getalso gets a full description of its lookup rules.A new project test fails if an override, its template, or a
:meth:reference to one is marked private. The pinned docs build reports 0 warnings.#1910changed someAppType.getreferences to plain literals. They can link again now, but this PR leaves them as they are.Closes #1921