Docstring/PEP 257 fixes for the restapi app (#2825)

Author: alexwlchan

readthedocs/restapi/client.py

@@ -16,7 +16,9 @@
 
 
 class DrfJsonSerializer(serialize.JsonSerializer):
-    '''Additional serialization help from the DRF parser/renderer'''
+
+    """Additional serialization help from the DRF parser/renderer"""
+
     key = 'json-drf'
 
     def loads(self, data):

readthedocs/restapi/permissions.py

@@ -4,9 +4,7 @@
 
 class IsOwner(permissions.BasePermission):
 
-    """
-    Custom permission to only allow owners of an object to edit it.
-    """
+    """Custom permission to only allow owners of an object to edit it."""
 
     def has_object_permission(self, request, view, obj):
         # Write permissions are only allowed to the owner of the snippet
@@ -24,9 +22,7 @@ def has_object_permission(self, request, view, comment):
 
 class RelatedProjectIsOwner(permissions.BasePermission):
 
-    """
-    Custom permission to only allow owners of an object to edit it.
-    """
+    """Custom permission to only allow owners of an object to edit it."""
 
     def has_permission(self, request, view):
         return (request.method in permissions.SAFE_METHODS)
@@ -41,12 +37,14 @@ def has_object_permission(self, request, view, obj):
 
 class APIPermission(permissions.IsAuthenticatedOrReadOnly):
 
-    '''
+    """
+    Control users access to the API.
+
     This permission should allow authenticated users readonly access to the API,
     and allow admin users write access. This should be used on API resources
     that need to implement write operations to resources that were based on the
     ReadOnlyViewSet
-    '''
+    """
 
     def has_permission(self, request, view):
         has_perm = super(APIPermission, self).has_permission(request, view)

readthedocs/restapi/utils.py

@@ -11,9 +11,7 @@
 
 
 def sync_versions(project, versions, type):
-    """
-    Update the database with the current versions from the repository.
-    """
+    """Update the database with the current versions from the repository."""
     # Bookkeeping for keeping tag/branch identifies correct
     verbose_names = [v['verbose_name'] for v in versions]
     project.versions.filter(verbose_name__in=verbose_names).update(type=type)
@@ -58,9 +56,7 @@ def sync_versions(project, versions, type):
 
 
 def delete_versions(project, version_data):
-    """
-    Delete all versions not in the current repo.
-    """
+    """Delete all versions not in the current repo."""
     current_versions = []
     if 'tags' in version_data:
         for version in version_data['tags']:

readthedocs/restapi/views/core_views.py

@@ -22,6 +22,7 @@
 def cname(request):
     """
     Get the slug that a particular hostname resolves to.
+
     This is useful for debugging your DNS settings,
     or for getting the backing project name on Read the Docs for a URL.
 

readthedocs/restapi/views/model_views.py

@@ -45,9 +45,7 @@ def get_queryset(self):
 
     @decorators.detail_route()
     def valid_versions(self, request, **kwargs):
-        """
-        Maintain state of versions that are wanted.
-        """
+        """Maintain state of versions that are wanted."""
         project = get_object_or_404(
             Project.objects.api(self.request.user), pk=kwargs['pk'])
         if not project.num_major or not project.num_minor or not project.num_point: