Repository navigation
docs: add a glossary for terms with several meanings (#1949) - #1955
Conversation
- add docs/source/glossary.rst for registry, schema, data model, info and default engine; each entry names its senses and links to the page that explains them, and the page sits between demo and changelog - point the ambiguous mentions in the engine, extraction, constants, test-coverage and protocol pages and docstrings at it with :term: - say Protocol.info returns a data model rather than an "Info dict", and fix the matching info_name, schema and NoPayload wording - label the extension guide's New Protocol section so the glossary links it - add tests/project/test_docs_glossary_1949_unit.py, which pins the page, its entries and links, and that every :term: role names a defined term Closes #1949
|
NEEDS CHANGES at |
- supply the missing noun in the info entry: the data model is stored in the enclosing layer's data model under info_name - say what the extension guide explains in the data model entry, rather than an unclear "it"
|
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
Adds
docs/source/glossary.rstfor the words with several meanings: registry, schema, data model, info and default engine (#1949). Each entry names its senses and links to the page that explains them, so it never repeats an explanation. The page sits betweendemoandchangelog.:term:.Protocol.infonow says it returns a data model rather than an "Info dict". The wording ofinfo_name,schemaandNoPayload._infois changed to match.ext.rstgains anext-new-protocollabel for the glossary to link to.tests/project/test_docs_glossary_1949_unit.pypins the page, its entries and links, and that every:term:role resolves, since CI'smake htmlonly warns on an unknown term. It fails onmain. The docs build has no warnings.Closes #1949