livery.extensions.mkdocstrings._docstrings¶
livery.extensions.mkdocstrings._docstrings ¶
Every name a python package exports has a docstring, which the reference publishes.
lint.docstrings imports each root of each python package, every
topmost package with an __init__.py as the API reference documents
them, in a child process and refuses a name in a root's __all__
whose object has no docstring, nor a string literal under its
assignment: a type alias carries no runtime __doc__, and the API
pages read the source. The packages are the ones a run reaches whose
set holds python, less those that turn the step off in their contract.
Functions:
| Name | Description |
|---|---|
assignment_docstrings |
The names under src documented by a string literal under their assignment. |
undocumented_exports |
The exports of members that carry no docstring, as dotted names. |
docstrings_run |
Refuse an export without a docstring: the lint phase's step. |
Attributes:
| Name | Type | Description |
|---|---|---|
STEP |
|
assignment_docstrings ¶
The names under src documented by a string literal under their assignment.
Source code in packages/extensions/mkdocstrings/src/livery/extensions/mkdocstrings/_docstrings.py
undocumented_exports ¶
The exports of members that carry no docstring, as dotted names.
Each root of each member (roots) is imported in one child process
of the interpreter running this one, which is the workspace's own,
so a package's import-time effects stay out of the gate's process.
Source code in packages/extensions/mkdocstrings/src/livery/extensions/mkdocstrings/_docstrings.py
docstrings_run ¶
docstrings_run(ctx: PhaseContext) -> None
Refuse an export without a docstring: the lint phase's step.
Judged over the python packages the run reaches
(livery.workshop.scoped_packages), each skip said.