Commitfc59e5e

committed

Improve stream_object_data and _parse_object_header docstrings

This slightly adjusts working and formatting of these methods ofthe Git class, for clarity.

1 parentc0a27c0 commitfc59e5eCopy full SHA for fc59e5e

File tree

-2

lines changed

-2

lines changed

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1491,7 +1491,9 @@ def _call_process(`
`1491`	`1491`	`def_parse_object_header(self,header_line:str)->Tuple[str,str,int]:`
`1492`	`1492`	`"""`
`1493`	`1493`	`:param header_line:`
`1494`		`- <hex_sha> type_string size_as_int`
	`1494`	`+ A line of the form::`
	`1495`	`+`
	`1496`	`+ <hex_sha> type_string size_as_int`
`1495`	`1497`
`1496`	`1498`	`:return:`
`1497`	`1499`	`(hex_sha, type_string, size_as_int)`
`@@ -1581,7 +1583,7 @@ def get_object_data(self, ref: str) -> Tuple[str, str, int, bytes]:`
`1581`	`1583`	`return (hexsha,typename,size,data)`
`1582`	`1584`
`1583`	`1585`	`defstream_object_data(self,ref:str)->Tuple[str,str,int,"Git.CatFileContentStream"]:`
`1584`		-"""Similar to :meth:`get_object_header`, but returns the data as a stream.
	`1586`	+"""Similar to :meth:`get_object_data`, but returns the data as a stream.
`1585`	`1587`
`1586`	`1588`	`:return:`
`1587`	`1589`	`(hexsha, type_string, size_as_int, stream)`

Comments

(0)