Fix docstring violations

This commit is contained in:
Ian Cordasco 2017-05-12 20:34:15 -05:00
parent 0e9bbab551
commit 32f4b65b6b
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
5 changed files with 13 additions and 15 deletions

View file

@ -16,7 +16,7 @@ class PluginClass(object):
version = '1.0.0'
def __init__(self, tree):
"""Dummy constructor to provide mandatory parameter."""
"""Construct a dummy object to provide mandatory parameter."""
pass
def run(self):
@ -25,7 +25,7 @@ class PluginClass(object):
def plugin_func(func):
"""Decorator for file plugins which are implemented as functions."""
"""Decorate file plugins which are implemented as functions."""
func.name = 'test'
func.version = '1.0.0'
return func
@ -33,13 +33,13 @@ def plugin_func(func):
@plugin_func
def plugin_func_gen(tree):
"""Simple file plugin function yielding the expected report."""
"""Yield the expected report."""
yield EXPECTED_REPORT + (type(plugin_func_gen), )
@plugin_func
def plugin_func_list(tree):
"""Simple file plugin function returning a list of reports."""
"""Return a list of expected reports."""
return [EXPECTED_REPORT + (type(plugin_func_list), )]