Add some docstrings

4 files changed, 11 insertions, 6 deletions

diff --git a/coverage/runners/__init__.py b/coverage/runners/__init__.py
index e69de29b..d8c86e88 100644
--- a/coverage/runners/__init__.py
+++ b/coverage/runners/__init__.py
@@ -0,0 +1 @@
+"""Coverage.py support for test runners."""
diff --git a/coverage/runners/noseplugin.py b/coverage/runners/noseplugin.py
index 930ef140..279293a1 100644
--- a/coverage/runners/noseplugin.py
+++ b/coverage/runners/noseplugin.py
@@ -3,8 +3,7 @@
 import logging
 from nose.plugins import Plugin
 
-from coverage.runners.plugin import CoverageTestWrapper
-from coverage.runners.plugin import options as coverage_opts
+from coverage.runners.plugin import CoverageTestWrapper, OPTIONS
 
 
 log = logging.getLogger("nose.plugins.coverage")
@@ -24,7 +23,7 @@ class Coverage(Plugin):
         """Add command-line options."""
 
         super(Coverage, self).options(parser, env)
-        for opt in coverage_opts:
+        for opt in OPTIONS:
             parser.add_option(opt)
 
     def configure(self, options, config):
diff --git a/coverage/runners/plugin.py b/coverage/runners/plugin.py
index 26bc9e7b..1ee946f1 100644
--- a/coverage/runners/plugin.py
+++ b/coverage/runners/plugin.py
@@ -13,6 +13,7 @@ class CoverageTestWrapper(object):
     3) Run your tests
     4) Call finish()
     5) Improve your code coverage ;)
+
     """
 
     coverPackages = None
@@ -29,6 +30,7 @@ class CoverageTestWrapper(object):
         self.coverPackages = options.cover_package
 
     def start(self):
+        """Start coverage before the test suite."""
         # cover_omit is a ',' separated list if provided
         self.omit = pattern_list(self.options.cover_omit)
         self.include = pattern_list(self.options.cover_omit)
@@ -46,6 +48,7 @@ class CoverageTestWrapper(object):
         self.coverage.start()
 
     def finish(self, stream=None):
+        """Finish coverage after the test suite."""
         self.coverage.stop()
         self.coverage.save()
 
@@ -79,6 +82,7 @@ class CoverageTestWrapper(object):
         return
 
     def _want_module(self, name, module):
+        """Determine if this module should be reported on."""
         for package in self.coverPackages:
             if module is not None and name.startswith(package):
                 return True
@@ -86,7 +90,8 @@ class CoverageTestWrapper(object):
         return False
 
 
-options = [
+# The command-line options for the plugin.
+OPTIONS = [
     optparse.Option('--cover-rcfile', action='store', metavar="RCFILE",
                     help="Specify configuration file.  ['.coveragerc']",
                     default=True),
diff --git a/coverage/runners/pytestplugin.py b/coverage/runners/pytestplugin.py
index af825aa9..0032b13b 100644
--- a/coverage/runners/pytestplugin.py
+++ b/coverage/runners/pytestplugin.py
@@ -1,11 +1,11 @@
 """py.test plugin hooks"""
 
-from coverage.runners.plugin import CoverageTestWrapper, options
+from coverage.runners.plugin import CoverageTestWrapper, OPTIONS
 
 def pytest_addoption(parser):
     """Get all the options from the coverage.runner and import them."""
     group = parser.getgroup('Coverage options')
-    for opt in options:
+    for opt in OPTIONS:
         group._addoption_instance(opt)
 
 def pytest_configure(config):