Commit2aa053e

committed

Add docstrings to TypedDicts in git.types

1 parent2af7640 commit2aa053eCopy full SHA for 2aa053e

File tree

+14

-0

lines changed

+14

-0

lines changed

Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -160,19 +160,33 @@ def assert_never(inp: NoReturn, raise_error: bool = True, exc: Union[Exception,`
`160`	`160`
`161`	`161`
`162`	`162`	`classFiles_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`	`+`
`163`	`169`	`insertions:int`
`164`	`170`	`deletions:int`
`165`	`171`	`lines:int`
`166`	`172`
`167`	`173`
`168`	`174`	`classTotal_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`	`+`
`169`	`181`	`insertions:int`
`170`	`182`	`deletions:int`
`171`	`183`	`lines:int`
`172`	`184`	`files:int`
`173`	`185`
`174`	`186`
`175`	`187`	`classHSH_TD(TypedDict):`
	`188`	+"""Dictionary carrying the same information as a :class:`~git.util.Stats` object."""
	`189`	`+`
`176`	`190`	`total:Total_TD`
`177`	`191`	`files:Dict[PathLike,Files_TD]`
`178`	`192`

Comments

(0)