diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2017-05-12 20:34:15 -0500 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2017-05-12 20:34:15 -0500 |
| commit | 32f4b65b6b4bb913e8f5201fc0a718878bfec7df (patch) | |
| tree | 355c4ea13f221c7ae317d6ced5cf9d89486f3a04 /src/flake8/api | |
| parent | 0e9bbab55134be3e1ce0b57046779d3e991740c5 (diff) | |
| download | flake8-32f4b65b6b4bb913e8f5201fc0a718878bfec7df.tar.gz | |
Fix docstring violations
Diffstat (limited to 'src/flake8/api')
| -rw-r--r-- | src/flake8/api/legacy.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/flake8/api/legacy.py b/src/flake8/api/legacy.py index e9d5630..2b983c8 100644 --- a/src/flake8/api/legacy.py +++ b/src/flake8/api/legacy.py @@ -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): |