Skip to content

Commit db71ed3

Browse files
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 inventory
1 parent 9be0ac2 commit db71ed3

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

src/libvcs/pytest_plugin.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ def unique_repo_name(remote_repos_path: pathlib.Path, max_retries: int = 15) ->
267267

268268
InitCmdArgs: t.TypeAlias = list[str] | None
269269
GitCommitEnvVars: t.TypeAlias = dict[str, str]
270+
"""Environment variable mapping passed to ``git commit`` subprocess calls."""
270271
Env: t.TypeAlias = _ENV
271272

272273

0 commit comments

Comments
 (0)