summaryrefslogtreecommitdiff
path: root/coverage/plugin_support.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-07-26 06:56:58 -0400
committerNed Batchelder <ned@nedbatchelder.com>2015-07-26 06:56:58 -0400
commitfd2284632777a235ac663b7b9912246b30bc538b (patch)
tree7e0fa1d7f0a1a830bb49c275054c855399ddd6e1 /coverage/plugin_support.py
parent498f7c997393752fd626af2c4353d5c9d7a85806 (diff)
downloadpython-coveragepy-fd2284632777a235ac663b7b9912246b30bc538b.tar.gz
Get rid of napoleon style docstrings, they don't format nicely.
Diffstat (limited to 'coverage/plugin_support.py')
-rw-r--r--coverage/plugin_support.py13
1 files changed, 4 insertions, 9 deletions
diff --git a/coverage/plugin_support.py b/coverage/plugin_support.py
index 5c577be..23c1bc1 100644
--- a/coverage/plugin_support.py
+++ b/coverage/plugin_support.py
@@ -51,7 +51,8 @@ class Plugins(object):
def add_file_tracer(self, plugin):
"""Add a file tracer plugin.
- ``plugin`` must implement the :meth:`CoveragePlugin.file_tracer` method.
+ `plugin` is an instance of a third-party plugin class. It must
+ implement the :meth:`CoveragePlugin.file_tracer` method.
"""
self._add_plugin(plugin, self.file_tracers)
@@ -67,13 +68,8 @@ class Plugins(object):
def _add_plugin(self, plugin, specialized):
"""Add a plugin object.
- Arguments:
- plugin (CoveragePlugin): the plugin to add.
-
- specialized (list): the list of plugins to add this to.
-
- Returns:
- plugin: may be a different object than passed in.
+ `plugin` is a :class:`CoveragePlugin` instance to add. `specialized`
+ is a list to append the plugin to.
"""
plugin_name = "%s.%s" % (self.current_module, plugin.__class__.__name__)
@@ -89,7 +85,6 @@ class Plugins(object):
self.names[plugin_name] = plugin
if specialized is not None:
specialized.append(plugin)
- return plugin
def __nonzero__(self):
return bool(self.order)