From b802f782fa8030d0146f027f6ee2fc6776b602b7 Mon Sep 17 00:00:00 2001 From: Ari Sosnovsky Date: Sun, 18 Oct 2020 13:19:17 -0400 Subject: [PATCH] more docs --- pdfmajor/parser_v2/objects.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pdfmajor/parser_v2/objects.py b/pdfmajor/parser_v2/objects.py index 10d0dbe..a776bbc 100644 --- a/pdfmajor/parser_v2/objects.py +++ b/pdfmajor/parser_v2/objects.py @@ -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)