Skip to content

Commit 2aa053e

Browse files
committed
Add docstrings to TypedDicts in git.types
1 parent 2af7640 commit 2aa053e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

git/types.py

+14
Original file line numberDiff line numberDiff line change
@@ -160,19 +160,33 @@ def assert_never(inp: NoReturn, raise_error: bool = True, exc: Union[Exception,
160160

161161

162162
class Files_TD(TypedDict):
163+
"""Dictionary with stat counts for the diff of a particular file.
164+
165+
For the :class:`~git.util.Stats.files` attribute of :class:`~git.util.Stats`
166+
objects.
167+
"""
168+
163169
insertions: int
164170
deletions: int
165171
lines: int
166172

167173

168174
class Total_TD(TypedDict):
175+
"""Dictionary with total stats from any number of files.
176+
177+
For the :class:`~git.util.Stats.total` attribute of :class:`~git.util.Stats`
178+
objects.
179+
"""
180+
169181
insertions: int
170182
deletions: int
171183
lines: int
172184
files: int
173185

174186

175187
class HSH_TD(TypedDict):
188+
"""Dictionary carrying the same information as a :class:`~git.util.Stats` object."""
189+
176190
total: Total_TD
177191
files: Dict[PathLike, Files_TD]
178192

0 commit comments

Comments
 (0)