From f54ffc4136eca63f3bf957c1825c83f608f06b73 Mon Sep 17 00:00:00 2001 From: Ian Adam Naval Date: Thu, 26 Feb 2015 18:22:51 -0500 Subject: [PATCH] Add docs for test formatter --- test/utils.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/utils.py b/test/utils.py index 6c73571..be7696c 100644 --- a/test/utils.py +++ b/test/utils.py @@ -3,6 +3,9 @@ from psh.commands import BaseCommand from io import StringIO class TestFormatter(BaseCommand): + """Formatter useful for tests. Instead of printing to stdout, it + stores any output inside a stringio buffer. This can be retrieved + with the get_data method.""" def __init__(self, *args, **kwargs): super(TestFormatter, self).__init__(*args, **kwargs)