From a0e1a60d23685d1a86c8a75f1ae24e865725a955 Mon Sep 17 00:00:00 2001 From: Carlos Muniz Date: Fri, 3 Dec 2021 09:23:17 -0500 Subject: [PATCH] docs: Describe messages descriptions better These messages have been updated to be more descriptive. The message descriptions need to be more descriptive in order to be easily translated (i18n) into other languages. --- .../GradesView/BulkManagementControls.messages.js | 2 +- .../GradesView/FilterMenuToggle.messages.js | 2 +- .../GradesView/ImportGradesButton.messages.js | 4 ++-- .../GradesView/ImportSuccessToast.messages.js | 4 ++-- .../GradesView/InterventionsReport.messages.js | 6 +++--- .../GradesView/ScoreViewInput.messages.js | 6 +++--- .../GradesView/SearchControls.messages.js | 4 ++-- src/components/GradesView/StatusAlerts.messages.js | 6 +++--- .../__snapshots__/FilterMenuToggle.test.jsx.snap | 2 +- .../__snapshots__/ImportGradesButton.test.jsx.snap | 4 ++-- .../InterventionsReport.test.jsx.snap | 6 +++--- .../__snapshots__/ScoreViewInput.test.jsx.snap | 2 +- .../__snapshots__/SearchControls.test.jsx.snap | 4 ++-- .../__snapshots__/StatusAlerts.test.jsx.snap | 2 +- src/data/constants/filters.messages.js | 14 +++++++------- 15 files changed, 34 insertions(+), 34 deletions(-) diff --git a/src/components/GradesView/BulkManagementControls.messages.js b/src/components/GradesView/BulkManagementControls.messages.js index c6e4e4e..6d7ef14 100644 --- a/src/components/GradesView/BulkManagementControls.messages.js +++ b/src/components/GradesView/BulkManagementControls.messages.js @@ -4,7 +4,7 @@ const messages = defineMessages({ downloadGradesBtn: { id: 'gradebook.GradesView.BulkManagementControls.bulkManagementLabel', defaultMessage: 'Download Grades', - description: 'Button text for bulk grades download control in GradesView', + description: 'A labeled button that allows an admin user to download course grades all at once (in bulk).', }, }); diff --git a/src/components/GradesView/FilterMenuToggle.messages.js b/src/components/GradesView/FilterMenuToggle.messages.js index 42a2e02..d028502 100644 --- a/src/components/GradesView/FilterMenuToggle.messages.js +++ b/src/components/GradesView/FilterMenuToggle.messages.js @@ -4,7 +4,7 @@ const messages = defineMessages({ editFilters: { id: 'gradebook.GradesView.editFilterLabel', defaultMessage: 'Edit Filters', - description: 'Button text on Grades tab to open/close the Filters tab', + description: 'A labeled button in the Grades tab that opens/closes the Filters tab, allowing the grades to be filtered', }, }); diff --git a/src/components/GradesView/ImportGradesButton.messages.js b/src/components/GradesView/ImportGradesButton.messages.js index 3e47d57..50abc4e 100644 --- a/src/components/GradesView/ImportGradesButton.messages.js +++ b/src/components/GradesView/ImportGradesButton.messages.js @@ -4,12 +4,12 @@ const messages = defineMessages({ csvUploadLabel: { id: 'gradebook.BulkManagementHistoryView.csvUploadLabel', defaultMessage: 'Upload Grade CSV', - description: 'Button in BulkManagementHistoryView Alerts', + description: 'A labeled button to upload a CSV containing course grades.', }, importGradesBtnText: { id: 'gradebook.GradesView.importGradesBtnText', defaultMessage: 'Import Grades', - description: 'Button in BulkManagement Tab File Upload Form', + description: 'A labeled button to import grades in the BulkManagement Tab File Upload Form', }, }); diff --git a/src/components/GradesView/ImportSuccessToast.messages.js b/src/components/GradesView/ImportSuccessToast.messages.js index f8ddc5a..90791f6 100644 --- a/src/components/GradesView/ImportSuccessToast.messages.js +++ b/src/components/GradesView/ImportSuccessToast.messages.js @@ -4,12 +4,12 @@ const messages = defineMessages({ description: { id: 'gradebook.GradesView.ImportSuccessToast.description', defaultMessage: 'Import Successful! Grades will be updated momentarily.', - description: 'Import Success Toast description', + description: 'A message congratulating a successful Import of grades', }, showHistoryViewBtn: { id: 'gradebook.GradesView.ImportSuccessToast.showHistoryViewBtn', defaultMessage: 'View Activity Log', - description: 'Button text for action that loads Bulk Management Activity Log view', + description: 'The text on a button that loads a view of the Bulk Management Activity Log', }, }); diff --git a/src/components/GradesView/InterventionsReport.messages.js b/src/components/GradesView/InterventionsReport.messages.js index e3aa8f1..373805f 100644 --- a/src/components/GradesView/InterventionsReport.messages.js +++ b/src/components/GradesView/InterventionsReport.messages.js @@ -4,17 +4,17 @@ const messages = defineMessages({ title: { id: 'gradebook.GradesView.InterventionsReport.title', defaultMessage: 'Interventions Report', - description: 'Intervention report subsection label', + description: 'The title for the Intervention report subsection', }, description: { id: 'gradebook.GradesView.InterventionsReport.description', defaultMessage: 'Need to find students who may be falling behind? Download the interventions report to obtain engagement metrics such as section attempts and visits.', - description: 'Intervention report subsection description', + description: 'The description for the Intervention report subsection', }, downloadBtn: { id: 'gradebook.GradesView.InterventionsReport.downloadBtn', defaultMessage: 'Download Interventions', - description: 'Button text for intervention report download control in GradesView', + description: 'The labeled button to download the Intervention report from the Grades View', }, }); diff --git a/src/components/GradesView/ScoreViewInput.messages.js b/src/components/GradesView/ScoreViewInput.messages.js index b4130fb..ed1dca5 100644 --- a/src/components/GradesView/ScoreViewInput.messages.js +++ b/src/components/GradesView/ScoreViewInput.messages.js @@ -4,17 +4,17 @@ const messages = defineMessages({ scoreView: { id: 'gradebook.GradesView.scoreViewLabel', defaultMessage: 'Score View', - description: 'Score format select dropdown label', + description: 'The label for the dropdown list that allows a user to select the Score format', }, absolute: { id: 'gradebook.GradesView.absoluteOption', defaultMessage: 'Absolute', - description: 'Score format select dropdown option', + description: 'A label within the Score Format dropdown list for the Absolute Grade Score option', }, percent: { id: 'gradebook.GradesView.percentOption', defaultMessage: 'Percent', - description: 'Score format select dropdown option', + description: 'A label within the Score Format dropdown list for the Percent Grade Score option', }, }); diff --git a/src/components/GradesView/SearchControls.messages.js b/src/components/GradesView/SearchControls.messages.js index 3212d77..79b117f 100644 --- a/src/components/GradesView/SearchControls.messages.js +++ b/src/components/GradesView/SearchControls.messages.js @@ -4,12 +4,12 @@ const messages = defineMessages({ label: { id: 'gradebook.GradesView.search.label', defaultMessage: 'Search for a learner', - description: 'Search description label', + description: 'Text prompting a user to use this functionality to search for a learner', }, hint: { id: 'gradebook.GradesView.search.hint', defaultMessage: 'Search by username, email, or student key', - description: 'Search hint label', + description: 'A hint explaining the ways a user can search', }, }); diff --git a/src/components/GradesView/StatusAlerts.messages.js b/src/components/GradesView/StatusAlerts.messages.js index f4defda..0e6a8da 100644 --- a/src/components/GradesView/StatusAlerts.messages.js +++ b/src/components/GradesView/StatusAlerts.messages.js @@ -4,17 +4,17 @@ const messages = defineMessages({ editSuccessAlert: { id: 'gradebook.GradesView.editSuccessAlert', defaultMessage: 'The grade has been successfully edited. You may see a slight delay before updates appear in the Gradebook.', - description: 'Alert text for successful edit action', + description: 'An alert text for successfully editing a grade', }, maxGradeInvalid: { id: 'gradebook.GradesView.maxCourseGradeInvalid', defaultMessage: 'Maximum course grade must be between 0 and 100', - description: 'Alert text for invalid maximum course grade', + description: 'An alert text for selecting a maximum course grade greater than 100', }, minGradeInvalid: { id: 'gradebook.GradesView.minCourseGradeInvalid', defaultMessage: 'Minimum course grade must be between 0 and 100', - description: 'Alert text for invalid minimum course grade', + description: 'An alert text for selecting a minimum course grade less than 0', }, }); diff --git a/src/components/GradesView/__snapshots__/FilterMenuToggle.test.jsx.snap b/src/components/GradesView/__snapshots__/FilterMenuToggle.test.jsx.snap index 02ef8a8..9b66b38 100644 --- a/src/components/GradesView/__snapshots__/FilterMenuToggle.test.jsx.snap +++ b/src/components/GradesView/__snapshots__/FilterMenuToggle.test.jsx.snap @@ -12,7 +12,7 @@ exports[`FilterMenuToggle component snapshots basic snapshot 1`] = ` diff --git a/src/components/GradesView/__snapshots__/ImportGradesButton.test.jsx.snap b/src/components/GradesView/__snapshots__/ImportGradesButton.test.jsx.snap index 6470ad6..79973a9 100644 --- a/src/components/GradesView/__snapshots__/ImportGradesButton.test.jsx.snap +++ b/src/components/GradesView/__snapshots__/ImportGradesButton.test.jsx.snap @@ -19,7 +19,7 @@ exports[`ImportGradesButton component snapshot snapshot - loads export form w/ a label={ } @@ -35,7 +35,7 @@ exports[`ImportGradesButton component snapshot snapshot - loads export form w/ a label={ Object { "defaultMessage": "Import Grades", - "description": "Button in BulkManagement Tab File Upload Form", + "description": "A labeled button to import grades in the BulkManagement Tab File Upload Form", "id": "gradebook.GradesView.importGradesBtnText", } } diff --git a/src/components/GradesView/__snapshots__/InterventionsReport.test.jsx.snap b/src/components/GradesView/__snapshots__/InterventionsReport.test.jsx.snap index 804c90e..44210b1 100644 --- a/src/components/GradesView/__snapshots__/InterventionsReport.test.jsx.snap +++ b/src/components/GradesView/__snapshots__/InterventionsReport.test.jsx.snap @@ -7,7 +7,7 @@ exports[`InterventionsReport component snapshots snapshot 1`] = ` > @@ -19,7 +19,7 @@ exports[`InterventionsReport component snapshots snapshot 1`] = ` > @@ -27,7 +27,7 @@ exports[`InterventionsReport component snapshots snapshot 1`] = ` label={ Object { "defaultMessage": "Download Interventions", - "description": "Button text for intervention report download control in GradesView", + "description": "The labeled button to download the Intervention report from the Grades View", "id": "gradebook.GradesView.InterventionsReport.downloadBtn", } } diff --git a/src/components/GradesView/__snapshots__/ScoreViewInput.test.jsx.snap b/src/components/GradesView/__snapshots__/ScoreViewInput.test.jsx.snap index 35d417f..44b805a 100644 --- a/src/components/GradesView/__snapshots__/ScoreViewInput.test.jsx.snap +++ b/src/components/GradesView/__snapshots__/ScoreViewInput.test.jsx.snap @@ -7,7 +7,7 @@ exports[`ScoreViewInput component snapshot - select box with percent and absolut : diff --git a/src/components/GradesView/__snapshots__/SearchControls.test.jsx.snap b/src/components/GradesView/__snapshots__/SearchControls.test.jsx.snap index d0515e8..d8fe548 100644 --- a/src/components/GradesView/__snapshots__/SearchControls.test.jsx.snap +++ b/src/components/GradesView/__snapshots__/SearchControls.test.jsx.snap @@ -6,7 +6,7 @@ exports[`SearchControls Component Snapshots basic snapshot 1`] = ` inputLabel={ } @@ -20,7 +20,7 @@ exports[`SearchControls Component Snapshots basic snapshot 1`] = ` > diff --git a/src/components/GradesView/__snapshots__/StatusAlerts.test.jsx.snap b/src/components/GradesView/__snapshots__/StatusAlerts.test.jsx.snap index 3fe5f39..df26d5b 100644 --- a/src/components/GradesView/__snapshots__/StatusAlerts.test.jsx.snap +++ b/src/components/GradesView/__snapshots__/StatusAlerts.test.jsx.snap @@ -7,7 +7,7 @@ exports[`StatusAlerts snapshots basic snapshot 1`] = ` dialog={ } diff --git a/src/data/constants/filters.messages.js b/src/data/constants/filters.messages.js index 6a5f619..48643e8 100644 --- a/src/data/constants/filters.messages.js +++ b/src/data/constants/filters.messages.js @@ -4,37 +4,37 @@ const messages = defineMessages({ assignment: { id: 'gradebook.GradesTab.FilterBadges.assignment', defaultMessage: 'Assignment', - description: 'Assignment FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows by which of the course\'s assignments the view is being filtered.', }, assignmentGrade: { id: 'gradebook.GradesTab.FilterBadges.assignmentGrade', defaultMessage: 'Assignment Grade', - description: 'Assignment Grade FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows that the view is being filtered to include assignment grades within the alloted range.', }, assignmentType: { id: 'gradebook.GradesTab.FilterBadges.assignmentType', defaultMessage: 'Assignment Type', - description: 'Assignment Type FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows by which of the course\'s assignment types the view is being filtered.', }, cohort: { id: 'gradebook.GradesTab.FilterBadges.cohort', defaultMessage: 'Cohort', - description: 'Cohort FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows by which of the course\'s cohorts the view is being filtered.', }, courseGrade: { id: 'gradebook.GradesTab.FilterBadges.courseGrade', defaultMessage: 'Course Grade', - description: 'Course Grade FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows that the view is being filtered to include course grades within the alloted range.', }, includeCourseRoleMembers: { id: 'gradebook.GradesTab.FilterBadges.includeCourseRoleMembers', defaultMessage: 'Include Course Team Members', - description: 'Include Course Team Members FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows that the view is being filtered to include course team members.', }, track: { id: 'gradebook.GradesTab.FilterBadges.track', defaultMessage: 'Track', - description: 'Track FilterBadge label', + description: 'A label describing the notification under the "Edit Filters" button that shows by which of the course\'s tracks the view is being filtered.', }, });