From ade3ec97eea8de8a9c765b555d03df5ed8e95096 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Tue, 8 Oct 2013 10:28:37 +0000 Subject: [PATCH] Give gnupg.GPGBase._read_data() a better docstring. --- gnupg/_meta.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/gnupg/_meta.py b/gnupg/_meta.py index 3ed7b1e..568f3a6 100644 --- a/gnupg/_meta.py +++ b/gnupg/_meta.py @@ -523,7 +523,15 @@ class GPGBase(object): result.stderr = ''.join(lines) def _read_data(self, stream, result): - """Read the contents of the file from GPG's stdout.""" + """Incrementally read from ``stream`` and store read data. + + All data gathered from calling ``stream.read()`` will be concatenated + and stored as ``result.data``. + + :param stream: An open file-like object to read() from. + :param result: An instance of one of the result parsing classes from + :attr:`GPGBase._result_mapping`. + """ chunks = [] while True: data = stream.read(1024)