Comments about project permissions and optimizations

Author: davidfischer

readthedocs/core/permissions.py

@@ -9,6 +9,8 @@ class AdminPermissionBase:
 
     @classmethod
     def is_admin(cls, user, project):
+        # This explicitly uses "user in project.users.all" so that
+        # users on projects can be cached using prefetch_related or prefetch_related_objects
         return user in project.users.all() or user.is_superuser
 
     @classmethod

readthedocs/projects/views/public.py

@@ -272,7 +272,7 @@ def project_versions(request, project_slug):
     if wiped and wiped_version.count():
         messages.success(request, 'Version wiped: ' + wiped)
 
-    # Optimize for the future project permission checks
+    # Optimize project permission checks
     prefetch_related_objects([project], 'users')
 
     return render(