Docstring/PEP 257 fixes for the P* apps (#2822)

* Docstring/PEP 257 fixes for the privacy app

* Docstring/PEP 257 fixes for the profiles app

* Docstring/PEP 257 fixes for the projects app

Author: alexwlchan

readthedocs/privacy/backends/syncers.py

@@ -12,9 +12,7 @@ class LocalSyncer(object):
 
     @classmethod
     def copy(cls, path, target, file=False, **kwargs):
-        """
-        A copy command that works with files or directories.
-        """
+        """A copy command that works with files or directories."""
         log.info("Local Copy %s to %s" % (path, target))
         if file:
             if path == target:

readthedocs/profiles/views.py

@@ -1,7 +1,4 @@
-"""
-Views for creating, editing and viewing site-specific user profiles.
-
-"""
+"""Views for creating, editing and viewing site-specific user profiles."""
 
 from django.contrib.auth.decorators import login_required
 from django.contrib.auth.models import User
@@ -18,8 +15,7 @@ def create_profile(request, form_class, success_url=None,
                    template_name='profiles/private/create_profile.html',
                    extra_context=None):
     """
-    Create a profile for the current user, if one doesn't already
-    exist.
+    Create a profile for the current user, if one doesn't already exist.
 
     If the user already has a profile, a redirect will be issued to the
     :view:`profiles.views.edit_profile` view.

readthedocs/projects/tasks.py

@@ -260,9 +260,7 @@ def setup_vcs(self):
                                         status_code=404)
 
     def get_env_vars(self):
-        """
-        Get bash environment variables used for all builder commands.
-        """
+        """Get bash environment variables used for all builder commands."""
         env = {
             'READTHEDOCS': True,
             'READTHEDOCS_VERSION': self.version.slug,
@@ -912,9 +910,7 @@ def clear_html_artifacts(version):
 
 @task(queue='web')
 def remove_path_from_web(path):
-    """
-    Remove the given path from the web servers file system.
-    """
+    """Remove the given path from the web servers file system."""
     # Santity check  for spaces in the path since spaces would result in
     # deleting unpredictable paths with "rm -rf".
     assert ' ' not in path, "No spaces allowed in path"

readthedocs/projects/views/private.py

@@ -331,11 +331,11 @@ class ImportView(PrivateViewMixin, TemplateView):
     wizard_class = ImportWizardView
 
     def get(self, request, *args, **kwargs):
-        '''Display list of repositories to import
+        """Display list of repositories to import
 
         Adds a warning to the listing if any of the accounts connected for the
         user are not supported accounts.
-        '''
+        """
         deprecated_accounts = (
             SocialAccount.objects
             .filter(user=self.request.user)