Docstring/PEP 257 fixes for the search app (#2824)

Author: alexwlchan

readthedocs/search/indexes.py

@@ -23,9 +23,9 @@
 
 
 class Index(object):
-    """
-    Base class to define some common methods across indexes.
-    """
+
+    """Base class to define some common methods across indexes."""
+
     # The _index and _type define the URL path to Elasticsearch, e.g.:
     #   http://localhost:9200/{_index}/{_type}/_search
     _index = 'readthedocs'
@@ -166,15 +166,11 @@ def delete_document(self, body, index=None, parent=None, routing=None):
         return self.es.delete_by_query(**kwargs)
 
     def get_mapping(self):
-        """
-        Returns the mapping for this _index and _type.
-        """
+        """Returns the mapping for this _index and _type."""
         raise NotImplementedError()
 
     def extract_document(self, data):
-        """
-        Extracts the Elasticsearch document for this object instance.
-        """
+        """Extracts the Elasticsearch document for this object instance."""
         raise NotImplementedError()
 
     def update_aliases(self, new_index, delete=True):

readthedocs/search/parse_json.py

@@ -12,9 +12,7 @@
 
 
 def process_all_json_files(version, build_dir=True):
-    """
-    Return a list of pages to index
-    """
+    """Return a list of pages to index"""
     if build_dir:
         full_path = version.project.full_json_path(version.slug)
     else:

readthedocs/search/utils.py

@@ -114,6 +114,7 @@ def parse_content_from_file(documentation_type, file_path):
 def parse_content(documentation_type, content):
     """
     Prepare the text of the html file.
+
     Returns the body text of a document
     """
     try:

readthedocs/search/views.py

@@ -15,9 +15,7 @@
 
 
 def elastic_search(request):
-    """
-    Use elastic search for global search
-    """
+    """Use Elasticsearch for global search"""
 
     query = request.GET.get('q')
     type = request.GET.get('type', 'project')