Finish PEP 257 cleanup and enable linting in CI (#2839)

* Fix a few remaining PEP 257 violations

* Enable PEP 257 linting in CI

Author: alexwlchan

prospector.yml

@@ -29,7 +29,7 @@ mccabe:
   run: false
 
 pep257:
-  run: false
+  run: true
   disable:
     - D105
     - D211

readthedocs/bookmarks/views.py

@@ -37,6 +37,7 @@ def get(self, request):
     def post(self, request, *args, **kwargs):
         """
         Returns:
+
             200 response with exists = True in json if bookmark exists.
             404 with exists = False in json if no matching bookmark is found.
             400 if json data is missing any one of: project, version, page.
@@ -71,7 +72,9 @@ def post(self, request, *args, **kwargs):
 
 
 class BookmarkListView(ListView):
-    """ Displays all of a logged-in user's bookmarks """
+
+    """Displays all of a logged-in user's bookmarks"""
+
     model = Bookmark
 
     @method_decorator(login_required)
@@ -83,7 +86,8 @@ def get_queryset(self):
 
 
 class BookmarkAddView(View):
-    """ Adds bookmarks in response to POST requests """
+
+    """Adds bookmarks in response to POST requests"""
 
     @method_decorator(login_required)
     @method_decorator(csrf_exempt)
@@ -100,8 +104,10 @@ def get(self, request):
         )
 
     def post(self, request, *args, **kwargs):
-        """Add a new bookmark for the current user to point at
-        ``project``, ``version``, ``page``, and ``url``.
+        """
+        Add a new bookmark for the current user.
+
+        Points at ``project``, ``version``, ``page``, and ``url``.
         """
         post_json = json.loads(request.body)
         try:
@@ -139,6 +145,7 @@ def post(self, request, *args, **kwargs):
 
 
 class BookmarkRemoveView(View):
+
     """
     Deletes a user's bookmark in response to a POST request.
 
@@ -158,8 +165,9 @@ def get(self, request, *args, **kwargs):
 
     def post(self, request, *args, **kwargs):
         """
-        Will delete bookmark with a primary key from the url
-        or using json data in request.
+        Delete a bookmark.
+
+        Uses the primary key from the URL or JSON data from the request.
         """
         if 'bookmark_pk' in kwargs:
             bookmark = get_object_or_404(Bookmark, pk=kwargs['bookmark_pk'])

readthedocs/builds/version_slug.py

@@ -73,6 +73,8 @@ def slugify(self, content):
 
     def uniquifying_suffix(self, iteration):
         """
+        Create a unique suffix.
+
         This creates a suffix based on the number given as ``iteration``. It
         will return a value encoded as lowercase ascii letter. So we have an
         alphabet of 26 letters. The returned suffix will be for example ``_yh``

readthedocs/doc_builder/base.py

@@ -51,10 +51,7 @@ def build(self, id=None, **kwargs):
         raise NotImplementedError
 
     def move(self, **kwargs):
-        """
-        Move the documentation from where it was generated to
-        its artifact directory.
-        """
+        """Move the generated documentation to its artifact directory."""
         if os.path.exists(self.old_artifact_path):
             if os.path.exists(self.target):
                 shutil.rmtree(self.target)

readthedocs/privacy/backend.py

@@ -177,8 +177,9 @@ class VersionQuerySet(SettingsOverrideObject):
 class BuildManager(models.Manager):
 
     """
-    Build objects that take into account the privacy of the Version
-    that they relate to.
+    Build objects that are privacy aware.
+
+    i.e. they take into account the privacy of the Version that they relate to.
     """
 
     use_for_related_fields = True