[Piglit] [PATCH 6/6] environment.py: Add docstrings

[Dylan Baker]

This patch adds docstrings to the remaining places that are needed.

V3: - spell checking

Signed-off-by: Dylan Baker <baker.dylan.c at gmail.com>
---
 framework/environment.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/framework/environment.py b/framework/environment.py
index 0ff2055..84815fd 100644
--- a/framework/environment.py
+++ b/framework/environment.py
@@ -15,6 +15,8 @@
 # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+""" Module for viewing and modifying the testing environment """
+
 
 import os
 import os.path as path
@@ -46,6 +48,19 @@ if 'MESA_DEBUG' not in os.environ:
 
 
 class Environment:
+    """ Object containing the piglit testing environment
+
+    Keyword Arguments:
+    concurrent -- run tests concurrently or serially. Default: True
+    execute -- run tests or only simulate running tests. Default: True
+    include_filter -- a list of strings which will be compiled to regex. Only
+                      tests matching these strings will be run. Default: []
+    exclude_filter -- a list of strings which will be compiled to regex. Tests
+                      matching these will not be run. Default: []
+    valgrind -- Run valgrind on tests. Default: False
+    dmesg -- check dmesg for failures. Default: False
+
+    """
     def __init__(self, concurrent=True, execute=True, include_filter=[],
                  exclude_filter=[], valgrind=False, dmesg=False):
         self.concurrent = concurrent
-- 
1.8.5.3