mirror of
https://github.com/PyCQA/flake8.git
synced 2026-03-29 10:36:53 +00:00
Fix docstring violations
This commit is contained in:
parent
0e9bbab551
commit
32f4b65b6b
5 changed files with 13 additions and 15 deletions
|
|
@ -68,7 +68,7 @@ class StyleGuide(object):
|
|||
|
||||
@property
|
||||
def options(self):
|
||||
"""The parsed options.
|
||||
"""Return application's options.
|
||||
|
||||
An instance of :class:`optparse.Values` containing parsed options.
|
||||
"""
|
||||
|
|
@ -76,7 +76,7 @@ class StyleGuide(object):
|
|||
|
||||
@property
|
||||
def paths(self):
|
||||
"""The extra arguments passed as paths."""
|
||||
"""Return the extra arguments passed as paths."""
|
||||
return self._application.paths
|
||||
|
||||
def check_files(self, paths=None):
|
||||
|
|
@ -178,7 +178,7 @@ class Report(object):
|
|||
|
||||
@property
|
||||
def total_errors(self):
|
||||
"""The total number of errors found by Flake8."""
|
||||
"""Return the total number of errors."""
|
||||
return self._application.result_count
|
||||
|
||||
def get_statistics(self, violation):
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ from flake8.main import application
|
|||
|
||||
def main(argv=None):
|
||||
# type: (Union[NoneType, List[str]]) -> NoneType
|
||||
"""Main entry-point for the flake8 command-line tool.
|
||||
"""Execute the main bit of the application.
|
||||
|
||||
This handles the creation of an instance of :class:`Application`, runs it,
|
||||
and then exits the application.
|
||||
|
|
|
|||
|
|
@ -103,8 +103,7 @@ class Option(object):
|
|||
|
||||
self._opt = None
|
||||
|
||||
def __repr__(self):
|
||||
"""Simple representation of an Option class."""
|
||||
def __repr__(self): # noqa: D105
|
||||
return (
|
||||
'Option({0}, {1}, action={action}, default={default}, '
|
||||
'dest={dest}, type={type}, callback={callback}, help={help},'
|
||||
|
|
@ -268,7 +267,7 @@ class OptionManager(object):
|
|||
setattr(options, option.dest, option.normalize(old_value))
|
||||
|
||||
def parse_args(self, args=None, values=None):
|
||||
"""Simple proxy to calling the OptionParser's parse_args method."""
|
||||
"""Proxy to calling the OptionParser's parse_args method."""
|
||||
self.generate_epilog()
|
||||
self.update_version_string()
|
||||
options, xargs = self.parser.parse_args(args, values)
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ class Plugin(object):
|
|||
"""Wrap an EntryPoint from setuptools and other logic."""
|
||||
|
||||
def __init__(self, name, entry_point):
|
||||
""""Initialize our Plugin.
|
||||
"""Initialize our Plugin.
|
||||
|
||||
:param str name:
|
||||
Name of the entry-point as it was registered with setuptools.
|
||||
|
|
@ -97,7 +97,7 @@ class Plugin(object):
|
|||
|
||||
@property
|
||||
def plugin(self):
|
||||
"""The loaded (and cached) plugin associated with the entry-point.
|
||||
"""Load and return the plugin associated with the entry-point.
|
||||
|
||||
This property implicitly loads the plugin and then caches it.
|
||||
"""
|
||||
|
|
@ -372,8 +372,7 @@ class PluginTypeManager(object):
|
|||
|
||||
@staticmethod
|
||||
def _generate_call_function(method_name, optmanager, *args, **kwargs):
|
||||
def generated_function(plugin):
|
||||
"""Function that attempts to call a specific method on a plugin."""
|
||||
def generated_function(plugin): # noqa: D105
|
||||
method = getattr(plugin, method_name, None)
|
||||
if (method is not None and
|
||||
isinstance(method, collections.Callable)):
|
||||
|
|
|
|||
|
|
@ -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), )]
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue