Commits

Anonymous committed 720a49d

Added skeleton doc files for current set of plugins

Comments (0)

Files changed (16)

 ===============
 nose2's plugins
 ===============
+
+.. toctree::
+   :maxdepth: 2
+
+   plugins/attrib
+   plugins/collect
+   plugins/doctests
+   plugins/loader
+   plugins/logcapture
+   plugins/outcomes
+   plugins/prof
+   plugins/testid

docs/plugins/attrib.rst

+===============================
+Selecting tests with attributes
+===============================
+
+.. automodule :: nose2.plugins.attrib
+   :members:

docs/plugins/collect.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.collect
+   :members:

docs/plugins/doctests.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.doctests
+   :members:

docs/plugins/loader.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.loader
+   :members:

docs/plugins/logcapture.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.logcapture
+   :members:

docs/plugins/outcomes.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.outcomes
+   :members:

docs/plugins/prof.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.prof
+   :members:

docs/plugins/testid.rst

+===========
+TODO: title
+===========
+
+.. automodule :: nose2.plugins.testid
+   :members:

nose2/plugins/attrib.py

 
 
 class AttributeSelector(Plugin):
+    """TODO: document"""
+
     def __init__(self):
         self.attribs = []
         self.register()

nose2/plugins/collect.py

 
 
 class CollectOnly(Plugin):
+    """TODO: document"""
+
     configSection = 'collect-only'
     commandLineSwitch = (None, 'collect-only',
                          'Collect and output test names, do not run any tests')

nose2/plugins/loader.py

 
 
 class Functions(ml.Functions):
+    """TODO: document"""
+
     configSection = 'nose-functions'
     unpack = unpack
 
 
 
 class Generators(ml.Generators):
+    """TODO: document"""
+
     configSection = 'nose-generators'
     unpack = unpack
 

nose2/plugins/logcapture.py

 
 
 class LogCapture(Plugin):
+    """TODO: document"""
+
     configSection = 'logging'
     commandLineSwitch = (None, 'log-capture', 'Enable log capture')
     logformat = '%(name)s: %(levelname)s: %(message)s'

nose2/plugins/outcomes.py

 from unittest2.events import hooks, Plugin
 
 class Outcomes(Plugin):
+    """TODO: document"""
 
     configSection = 'outcomes'
 

nose2/plugins/prof.py

 
 
 class Profiler(Plugin):
+    """TODO: document"""
+
     configSection = 'profiler'
     commandLineSwitch = ('P', 'profile', 'Run tests under profiler')
 

nose2/plugins/testid.py

 
 
 class TestId(Plugin):
+    """TODO: document"""
+
     configSection = 'testid'
     commandLineSwitch = ('I', 'with-id', 'Add test ids to output')
     idpat = re.compile(r'(\d+)')
 
     def nextId(self):
         """Increment ID and return it.
-        
+
         XXX: Make private?
         """
         self.id += 1
 
     def loadTestsFromName(self, event):
         """Implement hook.
-        
+
         If the name is a number, it might be an ID assigned by us. If we can
         find a test to which we have assigned that ID, event.name is changed to
         the test's real ID. In this way, tests can be referred to via sequential
 
     def loadIds(self):
         """Load previously pickled 'ids' and 'tests' attributes.
-        
+
         XXX: Make private?
         """
         if self._loaded: