From 81c664ae869956c7ba065d05a242f0a0c0a058ff Mon Sep 17 00:00:00 2001 From: Ari Sosnovsky Date: Wed, 14 Oct 2020 22:03:36 -0400 Subject: [PATCH] docs --- pdfmajor/tokenizer/token_parsers/string.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/pdfmajor/tokenizer/token_parsers/string.py b/pdfmajor/tokenizer/token_parsers/string.py index 5d16778..c3878e5 100644 --- a/pdfmajor/tokenizer/token_parsers/string.py +++ b/pdfmajor/tokenizer/token_parsers/string.py @@ -18,7 +18,16 @@ class StringParseState: escaped_value: Optional[bytes] = None -def parse_string(initialpos: int, inp: Iterator[PInput]): +def parse_string(initialpos: int, inp: Iterator[PInput]) -> TokenString: + """Parses input stream into a simple string object + + Args: + initialpos (int): initial position where we started + inp (Iterator[PInput]) + + Returns: + TokenString + """ state = StringParseState(b"", 1) for curpos, buf in inp: it = SafeBufferIt(buf)