more docs

This commit is contained in:
ari committed 2020-10-18 13:19:17 -04:00
1 parent 6e7c1f3888
commit b802f782fa
1 file changed
+6 -1
+6 -1
View File
@@ -75,7 +75,12 @@ class PDFComment(PDFObject):
def get_value(self):
return self.comment
def to_python(self):
def to_python(self) -> Tuple[bytes, Tuple[int, int]]:
"""returns the value of the comment and where it is in the byte-strea,
Returns:
Tuple[bytes, Tuple[int, int]]: the first value in the tuple is the comment value and the second is the start and end location in the byte stream
"""
return (self.get_value(), self.location)