Commits

Jason Pellerin committed 68aafe7

Clarified plugin api change in 0.11, compatibility with 0.10 and 0.9

Comments (0)

Files changed (2)

nose/plugins/base.py

 
     def add_options(self, parser, env=None):
         """Non-camel-case version of func name for backwards compatibility.
+
+        .. warning ::
+
+           DEPRECATED: Do not use this method,
+           use :meth:`options <nose.plugins.base.IPluginInterface.options>`
+           instead.
+
         """
         # FIXME raise deprecation warning if wasn't called by wrapper
         if env is None:
         Do *not* return a value from this method unless you want to stop
         all other plugins from setting their options.
 
-        .. Note:: DEPRECATED -- implement `options` instead.
+        .. warning ::
+
+           DEPRECATED -- implement
+           :meth:`options <nose.plugins.base.IPluginInterface.options>` instead.
         """
         pass
     add_options = addOptions
         unless you want to stop other plugins from seeing the deprecated
         test.
 
-        .. Note:: DEPRECATED -- check error class in addError instead
+        .. warning :: DEPRECATED -- check error class in addError instead
 
         :Parameters:
           test : :class:`nose.case.Test`
           capt : string
             Captured output, if any
 
-            .. Note:: DEPRECATED: this parameter will not be passed
+            .. warning :: DEPRECATED: this parameter will not be passed
         """
         pass
     addError.changed = True
           capt : string
             Captured output, if any.
 
-            .. Note:: DEPRECATED: this parameter will not be passed
+            .. warning:: DEPRECATED: this parameter will not be passed
           tb_info : string
             Introspected traceback info, if any
 
-            .. Note:: DEPRECATED: this parameter will not be passed
+            .. warning:: DEPRECATED: this parameter will not be passed
         """
         pass
     addFailure.changed = True
         """Called when a test is skipped. DO NOT return a value unless
         you want to stop other plugins from seeing the skipped test.
 
-        .. Note:: DEPRECATED -- check error class in addError instead
+        .. warning:: DEPRECATED -- check error class in addError instead
 
         :Parameters:
           test : :class:`nose.case.Test`
           capt : string
             Captured output, if any.
 
-            .. Note:: DEPRECATED: this parameter will not be passed
+            .. warning:: DEPRECATED: this parameter will not be passed
         """
         pass
     addSuccess.changed = True
 
     def describeTest(self, test):
         """Return a test description. Called by
-        `nose.case.Test.shortDescription`.
+        :meth:`nose.case.Test.shortDescription`.
 
         :Parameters:
           test : :class:`nose.case.Test`
             The module object
           path : the path of the module to search, to
             distinguish from namespace package modules
+
+            .. note::
+
+               NEW. The ``path`` parameter will only be passed by nose 0.11
+               or above.
         """
         pass
     loadTestsFromModule.generative = True
           importPath :
             Path from which file (must be a python module) was found
 
-            .. Note:: DEPRECATED: this argument will NOT be passed.
+            .. warning:: DEPRECATED: this argument will NOT be passed.
         """
         pass
     loadTestsFromName.generative = True
 
     def loadTestsFromPath(self, path):
         """
-        .. Note:: DEPRECATED -- use loadTestsFromFile instead
+        .. warning:: DEPRECATED -- use loadTestsFromFile instead
         """
         pass
     loadTestsFromPath.deprecated = True
 
         :Parameters:
           parser : :class:`ConfigParser`
-            options parserinstance
+            options parser instance
 
           env : dict
             environment, defaults to os.environ
     
     def wantModuleTests(self, module):
         """
-        .. Note:: DEPRECATED -- this method will not be called, it has
-                  been folded into wantModule.
+        .. warning:: DEPRECATED -- this method will not be called, it has
+             been folded into wantModule.
         """
         pass
     wantModuleTests.deprecated = True
 0.9 plugins
 -----------
 
-nose 0.10 can use SOME plugins that were written for nose 0.9. The
+nose 0.11 can use SOME plugins that were written for nose 0.9. The
 default plugin manager inserts a compatibility wrapper around 0.9
 plugins that adapts the changed plugin api calls. However, plugins
 that access nose internals are likely to fail, especially if they
 longer passed to startTest and partly because it's likely that the
 plugin is trying to find out if the test is an instance of a class
 that no longer exists.
+
+0.10 plugins
+------------
+
+All plugins written for nose 0.10 should work with nose 0.11.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.