Commit db71ed3
committed
pytest_plugin(docs[GitCommitEnvVars]): Add docstring to GitCommitEnvVars TypeAlias
why: sphinx's automodule :members: skips module-level TypeAliases whose
value has a __module__ that differs from the documented module (e.g.
dict[str, str] has __module__ = 'builtins'). Static source analysis via
ModuleAnalyzer.attr_docs only picks up the member when a docstring is
present. Without it, GitCommitEnvVars never enters the py:data inventory
and cannot be cross-referenced from the fixture summary table.
what:
- Add one-line docstring to GitCommitEnvVars: TypeAlias so sphinx's
static analyser includes it in automodule :members: output, registering
it as a py:data entry in the Sphinx inventory1 parent 9be0ac2 commit db71ed3
1 file changed
+1
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
267 | 267 | | |
268 | 268 | | |
269 | 269 | | |
| 270 | + | |
270 | 271 | | |
271 | 272 | | |
272 | 273 | | |
| |||
0 commit comments