From 7ee8254edb6a64dbc0bfe4dfdea3b3c2b31dc195 Mon Sep 17 00:00:00 2001 From: Ari Sosnovsky Date: Sat, 17 Oct 2020 20:17:47 -0400 Subject: [PATCH] more docs --- pdfmajor/lexer/__init__.py | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/pdfmajor/lexer/__init__.py b/pdfmajor/lexer/__init__.py index d524b24..45b0827 100644 --- a/pdfmajor/lexer/__init__.py +++ b/pdfmajor/lexer/__init__.py @@ -22,10 +22,23 @@ class PDFLexer: def __init__(self, fp: io.BufferedIOBase, buffer_size: int = 4096) -> None: self.buffer = BufferStream(fp, buffer_size=buffer_size) - def seek(self, pos: int): - self.buffer.seek(pos) + def seek(self, pos: int) -> int: + """moves the offset of the reader to a certain spot, and returns the new offset + + Args: + offset (int) + + Returns: + int: new offset + """ + return self.buffer.seek(pos) def iter_tokens(self) -> Iterator[Token]: + """Iterates over the tokens in the stream + + Yields: + Iterator[Token] + """ for bufpos, buf in self.buffer: m = NONSPC.search(buf, 0) if not m: