Fix bug in PEP257 conformance test, and fix docstring violations. (#465)

Fixes #464.

Author: Nurdok

src/pydocstyle/checker.py

@@ -1004,7 +1004,7 @@ def get_leading_words(line):
         return result.group()
 
 def is_def_arg_private(arg_name):
-    """Returns a boolean indicating if the argument name is private."""
+    """Return a boolean indicating if the argument name is private."""
     return arg_name.startswith("_")
 
 def get_function_args(function_string):

src/pydocstyle/cli.py

@@ -71,7 +71,7 @@ def main():
 
 
 def setup_stream_handlers(conf):
-    """Setup logging stream handlers according to the options."""
+    """Set up logging stream handlers according to the options."""
     class StdoutFilter(logging.Filter):
         def filter(self, record):
             return record.levelno in (logging.DEBUG, logging.INFO)

src/pydocstyle/parser.py

@@ -14,6 +14,8 @@
 
 
 class ParseError(Exception):
+    """An error parsing contents of a Python file."""
+
     def __str__(self):
         return "Cannot parse file."
 
@@ -111,6 +113,10 @@ class Module(Definition):
 
     @property
     def is_public(self):
+        """Return True iff the module is considered public.
+
+        This helps determine if it requires a docstring.
+        """
         return not self.name.startswith('_') or self.name.startswith('__')
 
     def __str__(self):
@@ -183,6 +189,7 @@ def is_public(self):
 
     @property
     def is_static(self):
+        """Return True iff the method is static."""
         for decorator in self.decorators:
             if decorator.name == "staticmethod":
                 return True
@@ -221,6 +228,7 @@ class Docstring(str):
     the start and end of the token.
 
     """
+
     def __new__(cls, v, start, end):
         return str.__new__(cls, v)
 
@@ -372,9 +380,9 @@ def parse_docstring(self):
         return None
 
     def parse_decorators(self):
-        """Called after first @ is found.
+        """Parse decorators into self._accumulated_decorators.
 
-        Parse decorators into self._accumulated_decorators.
+        Called after first @ is found.
         Continue to do so until encountering the 'def' or 'class' start token.
         """
         name = []

src/pydocstyle/wordlists.py

@@ -35,8 +35,8 @@ def load_wordlist(name: str) -> Iterator[str]:
                 yield line
 
 
-#: A dict mapping stemmed verbs to the imperative form
 def make_imperative_verbs_dict(wordlist: Iterator[str]) -> Dict[str, Set[str]]:
+    """Create a dictionary mapping stemmed verbs to the imperative form."""
     imperative_verbs = {}  # type: Dict[str, Set[str]]
     for word in wordlist:
         imperative_verbs.setdefault(stem(word), set()).add(word)

src/tests/test_integration.py

@@ -150,10 +150,9 @@ def parse_errors(err):
 def test_pep257_conformance():
     """Test that we conform to PEP 257."""
     base_dir = (pathlib.Path(__file__).parent / '..').resolve()
-    src_dirs = (base_dir, base_dir / 'tests')
-    src_files = []
-    for src_dir in src_dirs:
-        src_files.extend(str(path) for path in src_dir.glob('*.py'))
+    excluded = base_dir / 'tests' / 'test_cases'
+    src_files = (str(path) for path in base_dir.glob('**/*.py')
+                 if excluded not in path.parents)
 
     ignored = {'D104', 'D105'}
     select = violations.conventions.pep257 - ignored