Doc string updates.

openassessment/assessment/api/peer.py

@@ -285,16 +285,16 @@ def create_assessment(
         logger.exception(message)
         raise PeerAssessmentWorkflowError(message)
     except InvalidRubric:
-        msg = u"Rubric definition was not valid"
+        msg = u"The rubric definition is not valid."
         logger.exception(msg)
         raise PeerAssessmentRequestError(msg)
     except InvalidRubricSelection:
-        msg = u"Invalid options selected in the rubric"
+        msg = u"Invalid options were selected in the rubric."
         logger.warning(msg, exc_info=True)
         raise PeerAssessmentRequestError(msg)
     except DatabaseError:
         error_message = (
-            u"An error occurred while retrieving the peer workflow item by scorer with ID: {}"
+            u"An error occurred while creating an assessment by the scorer with this ID: {}"
         ).format(scorer_id)
         logger.exception(error_message)
         raise PeerAssessmentInternalError(error_message)

openassessment/assessment/api/staff.py

@@ -227,16 +227,16 @@ def create_assessment(
         return full_assessment_dict(assessment)
 
     except InvalidRubric:
-        error_message = u"Rubric definition was not valid"
+        error_message = u"The rubric definition is not valid."
         logger.exception(error_message)
         raise StaffAssessmentRequestError(error_message)
     except InvalidRubricSelection:
-        error_message = u"Invalid options selected in the rubric"
+        error_message = u"Invalid options were selected in the rubric."
         logger.warning(error_message, exc_info=True)
         raise StaffAssessmentRequestError(error_message)
     except DatabaseError:
         error_message = (
-            u"An error occurred while creating assessment by scorer with ID: {}"
+            u"An error occurred while creating an assessment by the scorer with this ID: {}"
         ).format(scorer_id)
         logger.exception(error_message)
         raise StaffAssessmentInternalError(error_message)

openassessment/assessment/test/test_staff.py

@@ -311,7 +311,7 @@ class TestStaffAssessment(CacheResetTest):
                 OPTIONS_SELECTED_DICT["most"]["options"], dict(), "",
                 invalid_rubric,
             )
-        self.assertEqual(str(context_manager.exception), u"Rubric definition was not valid")
+        self.assertEqual(str(context_manager.exception), u"The rubric definition is not valid.")
 
     @data("criterion_not_found", "option_not_found", "missing_criteria", "some_criteria_not_assessed")
     def test_invalid_rubric_options_exception(self, invalid_reason):
@@ -337,7 +337,7 @@ class TestStaffAssessment(CacheResetTest):
                 dict_to_use, dict(), "",
                 RUBRIC,
             )
-        self.assertEqual(str(context_manager.exception), u"Invalid options selected in the rubric")
+        self.assertEqual(str(context_manager.exception), u"Invalid options were selected in the rubric.")
 
     @mock.patch.object(Assessment.objects, 'filter')
     def test_database_filter_error_handling(self, mock_filter):
@@ -379,7 +379,7 @@ class TestStaffAssessment(CacheResetTest):
             )
         self.assertEqual(
             str(context_manager.exception),
-            u"An error occurred while creating assessment by scorer with ID: {}".format("Dumbledore")
+            u"An error occurred while creating an assessment by the scorer with this ID: {}".format("Dumbledore")
         )
 
     @staticmethod

openassessment/templates/openassessmentblock/edit/oa_edit.html

@@ -21,7 +21,7 @@
             <i class="openassessment_alert_icon"></i>
             <div class="openassessment_alert_header">
                 <h2 class="openassessment_alert_title">{% trans "Rubric Change Impacts Settings Section" %}</h2>
-                <p class="openassessment_alert_message">{% trans "A change that you made to this assessment's rubric has an impact on some examples laid out in the settings tab. For more information, go to the Settings section and fix areas highlighted in red." %}</p>
+                <p class="openassessment_alert_message">{% trans "A change that you made to this assessment's rubric has an impact on some examples laid out in the settings tab. For more information, go to the Settings section and fix the areas highlighted in red." %}</p>
             </div>
             <a href="" rel="view" class="action openassessment_alert_close">
                 <i class="icon fa fa-times-circle" aria-hidden="true"></i>

openassessment/xblock/data_conversion.py

@@ -235,13 +235,13 @@ def verify_assessment_parameters(func):
     def verify_and_call(instance, data, suffix):
         # Validate the request
         if 'options_selected' not in data:
-            return {'success': False, 'msg': instance._('Must provide options selected in the assessment')}
+            return {'success': False, 'msg': instance._('You must provide options selected in the assessment.')}
 
         if 'overall_feedback' not in data:
-            return {'success': False, 'msg': instance._('Must provide overall feedback in the assessment')}
+            return {'success': False, 'msg': instance._('You must provide overall feedback in the assessment.')}
 
         if 'criterion_feedback' not in data:
-            return {'success': False, 'msg': instance._('Must provide feedback for criteria in the assessment')}
+            return {'success': False, 'msg': instance._('You must provide feedback for criteria in the assessment.')}
 
         return func(instance, data, suffix)
     return verify_and_call

openassessment/xblock/peer_assessment_mixin.py

@@ -52,7 +52,9 @@ class PeerAssessmentMixin(object):
 
         """
         if self.submission_uuid is None:
-            return {'success': False, 'msg': self._('You must submit a response before you can peer-assess.')}
+            return {
+                'success': False, 'msg': self._('You must submit a response before you can perform a peer assessment.')
+            }
 
         uuid_server, uuid_client = self._get_server_and_client_submission_uuids(data)
         if uuid_server != uuid_client:

openassessment/xblock/staff_assessment_mixin.py

@@ -38,7 +38,9 @@ class StaffAssessmentMixin(object):
         Create a staff assessment from a staff submission.
         """
         if 'submission_uuid' not in data:
-            return {'success': False, 'msg': self._(u"Missing the submission id of the submission being assessed.")}
+            return {
+                'success': False, 'msg': self._(u"The submission ID of the submission being assessed was not found.")
+            }
 
         try:
             assessment = staff_api.create_assessment(
@@ -123,7 +125,7 @@ class StaffAssessmentMixin(object):
                 context = {
                     'status_value': self._('Complete'),
                     'icon_class': 'fa-check',
-                    'message_title': self._('You Must Complete the Above Steps to View Your Grade'),
+                    'message_title': self._('You Must Complete the Steps Above to View Your Grade'),
                     'message_content': self._('Although a course staff member has assessed your response, you will receive your grade only after you have completed all the required steps of this problem.'),
                 }
             else:  # Both student and staff still have work to do, just show "Not Available".

openassessment/xblock/static/js/spec/lms/oa_staff_area.js

@@ -260,7 +260,7 @@ describe('OpenAssessment.StaffAreaView', function() {
             var staffArea = createStaffArea();
             chooseStudent(staffArea, '');
             expect($('.openassessment_student_info_form .form--error', staffArea.element).text().trim())
-                .toBe('A learner name must be provided.');
+                .toBe('You must provide a learner name.');
         });
 
         describe('Submission Management', function() {

openassessment/xblock/static/js/src/lms/oa_staff_area.js

@@ -109,7 +109,7 @@
                     deferred.reject();
                 });
             } else {
-                showFormError(gettext('A learner name must be provided.'));
+                showFormError(gettext('You must provide a learner name.'));
                 deferred.reject();
             }
             return deferred.promise();

openassessment/xblock/test/test_staff.py

@@ -84,7 +84,7 @@ class TestStaffAssessmentRender(StaffAssessmentTestBase, SubmitAssessmentsMixin)
             {
                 'status_value': 'Complete',
                 'icon_class': 'fa-check',
-                'message_title': 'You Must Complete the Above Steps to View Your Grade',
+                'message_title': 'You Must Complete the Steps Above to View Your Grade',
                 'message_content': 'Although a course staff member has assessed your response, you will receive your grade only after you have completed all the required steps of this problem.'
             }
         )

test/acceptance/tests.py

@@ -232,7 +232,7 @@ class PeerAssessmentTestStaffOverride(OpenAssessmentTest):
 
         # Refresh the page so the learner sees the Staff Grade section.
         self.browser.refresh()
-        self._verify_staff_grade_section("COMPLETE", "YOU MUST COMPLETE THE ABOVE STEPS TO VIEW YOUR GRADE")
+        self._verify_staff_grade_section("COMPLETE", "YOU MUST COMPLETE THE STEPS ABOVE TO VIEW YOUR GRADE")
 
         # Verify no final grade yet.
         self.assertIsNone(self.grade_page.wait_for_page().score)
@@ -519,7 +519,7 @@ class StaffAreaTest(OpenAssessmentTest):
 
         # Refresh the page so the learner sees the Staff Grade section.
         self.browser.refresh()
-        self._verify_staff_grade_section("COMPLETE", "YOU MUST COMPLETE THE ABOVE STEPS TO VIEW YOUR GRADE")
+        self._verify_staff_grade_section("COMPLETE", "YOU MUST COMPLETE THE STEPS ABOVE TO VIEW YOUR GRADE")
 
         # Verify no final grade yet.
         self.assertIsNone(self.grade_page.wait_for_page().score)