Minor cosmetic updates

Author: flexthink

README.md

@@ -18,6 +18,7 @@ Done:
 - The Item Response Theory engine
 
 Still in Progress (was part of the original project)
+- Authorization with roles
 - Question difficulty reestimation
 - Support for multiple question types
 - Question categorization by concept

quizzical-api/api/questions.py

@@ -28,18 +28,30 @@
 
 @api.route('/<question_uuid>')
 class QuestionResource(Resource):
+    """
+    A resource for individual questions
+    """
     @api.marshal_with(QUESTION_MODEL)
     @jwt_required
     def get(self, question_uuid):
+        """
+        GET handler
+        """
         return Question.objects(uuid=question_uuid).first()
 
     @api.expect(QUESTION_MODEL, validate=True)
     @jwt_required
     def put(self, question_uuid):
+        """
+        PUT handler
+        """
         edit_question = Question(**api.payload)
         edit_question.uuid = question_uuid
         edit_question.save()
 
     @jwt_required
     def delete(self, question_uuid):
+        """
+        DELETE handler
+        """
         Question.objects(uuid=question_uuid).delete()

quizzical-api/api/users.py

@@ -38,7 +38,7 @@
 @sort_paginate_params(api)
 class UserListResource(Resource):
     """
-    A resource for the student list
+    A resource for the user list
     """
     @api.marshal_list_with(USER_MODEL)
     @sort_paginate(allow_sort=['first_name', 'last_name', 'email'])
@@ -52,7 +52,7 @@ def get(self):
 @api.route('/<user_id>')
 class UserResource(Resource):
     """
-    A resource for retrieving individual students
+    A resource for retrieving individual users
     """
     @api.marshal_with(USER_MODEL)
     def get(self, user_id):