pep257 module comments for tests

Author: tony

tmuxp/testsuite/helpers.py

@@ -1,4 +1,13 @@
 # -*- coding: utf-8 -*-
+"""Helper methods for tmuxp unittests.
+
+tmuxp.tests.helpers
+~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
 from __future__ import absolute_import, division, print_function, with_statement
 
 import time
@@ -76,10 +85,10 @@ def bootstrap(self):
         except exc.TmuxpException as e:
             raise e
 
-        '''
-        Make sure that tmuxp can :ref:`test_builder_visually` and switches to the
-        newly created session for that testcase.
-        '''
+        """
+        Make sure that tmuxp can :ref:`test_builder_visually` and switches to
+        the newly created session for that testcase.
+        """
         try:
             t.switch_client(session.get('session_id'))
             pass
@@ -88,8 +97,10 @@ def bootstrap(self):
             pass
 
         for old_test_session in old_test_sessions:
-            logger.debug('Old test test session %s found. Killing it.' %
-                        old_test_session)
+            logger.debug(
+                'Old test test session %s found. Killing it.' %
+                old_test_session
+            )
             t.kill_session(old_test_session)
         assert TEST_SESSION_NAME == session.get('session_name')
         assert TEST_SESSION_NAME != 'tmuxp'

tmuxp/testsuite/test_cli.py

@@ -1,4 +1,13 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp command line interface.
+
+tmuxp.tests.test_cli
+~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os

tmuxp/testsuite/test_config.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp configuration import, inlining, expanding and export.
+
+tmuxp.tests.test_config
+~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os

tmuxp/testsuite/test_config_teamocil.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp teamocil configuration..
+
+tmuxp.tests.test_config_teamocil
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os

tmuxp/testsuite/test_config_tmuxinator.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp tmuxinator configuration.
+
+tmuxp.tests.test_config_tmuxinator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os

tmuxp/testsuite/test_pane.py

@@ -1,4 +1,13 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp Pane object.
+
+tmuxp.tests.test_pane
+~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
 from __future__ import absolute_import, division, print_function, with_statement
 
 from . import t

tmuxp/testsuite/test_server.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp Server object.
+
+tmuxp.tests.test_server
+~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 from random import randint

tmuxp/testsuite/test_session.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp Session object.
+
+tmuxp.tests.test_session
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 from random import randint

tmuxp/testsuite/test_tmuxobject.py

@@ -1,4 +1,13 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp TmuxRelationalObject and TmuxMappingObject.
+
+tmuxp.tests.test_tmuxobject
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
 from __future__ import absolute_import, division, print_function, with_statement
 
 import random

tmuxp/testsuite/test_window.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp Window object.
+
+tmuxp.tests.test_window
+~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 from .. import Pane, Window, Server

tmuxp/testsuite/test_workspacebuilder.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp workspacebuilder.
+
+tmuxp.tests.test_workspacebuilder
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os

tmuxp/testsuite/test_workspacefreezer.py

@@ -1,4 +1,14 @@
 # -*- coding: utf-8 -*-
+"""Test for tmuxp workspacefreezer.
+
+tmuxp.tests.test_workspacefreezer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:copyright: Copyright 2013 Tony Narlock.
+:license: BSD, see LICENSE for details
+
+"""
+
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os