From a3a58533a844678f5bc66604f6ca9e4ff67c6993 Mon Sep 17 00:00:00 2001
From: stvn <stvn@mit.edu>
Date: Tue, 13 Apr 2021 22:17:02 -0700
Subject: [PATCH] docs: Add and cleanup comments

---
 common/djangoapps/student/tests/factories.py |  2 --
 lms/djangoapps/courseware/tests/factories.py | 27 +++++++++++++++-----
 2 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/common/djangoapps/student/tests/factories.py b/common/djangoapps/student/tests/factories.py
index ee1610e8e7..07381ce0b2 100644
--- a/common/djangoapps/student/tests/factories.py
+++ b/common/djangoapps/student/tests/factories.py
@@ -33,8 +33,6 @@ from common.djangoapps.student.roles import CourseStaffRole
 from common.djangoapps.student.roles import OrgInstructorRole
 from common.djangoapps.student.roles import OrgStaffRole
 
-# Factories are self documenting
-
 TEST_PASSWORD = 'test'
 
 
diff --git a/lms/djangoapps/courseware/tests/factories.py b/lms/djangoapps/courseware/tests/factories.py
index fc62b5df86..7f87b8375c 100644
--- a/lms/djangoapps/courseware/tests/factories.py
+++ b/lms/djangoapps/courseware/tests/factories.py
@@ -1,6 +1,9 @@
-# Factories are self documenting  # lint-amnesty, pylint: disable=missing-module-docstring
-
+"""
+Build courseware-centric test factories
 
+Generic, LMS-agnostic factories can be found in:
+`common.djangoapps.student.tests.factories.py`
+"""
 import json
 from functools import partial
 
@@ -21,7 +24,10 @@ COURSE_KEY = CourseKey.from_string('edX/test_course/test')
 LOCATION = partial(COURSE_KEY.make_usage_key, 'problem')
 
 
-class StudentModuleFactory(DjangoModelFactory):  # lint-amnesty, pylint: disable=missing-class-docstring
+class StudentModuleFactory(DjangoModelFactory):
+    """
+    Build StudentModule models
+    """
     class Meta:
         model = StudentModule
 
@@ -34,7 +40,10 @@ class StudentModuleFactory(DjangoModelFactory):  # lint-amnesty, pylint: disable
     done = 'na'
 
 
-class UserStateSummaryFactory(DjangoModelFactory):  # lint-amnesty, pylint: disable=missing-class-docstring
+class UserStateSummaryFactory(DjangoModelFactory):
+    """
+    Build XModuleUserStateSummaryField models
+    """
     class Meta:
         model = XModuleUserStateSummaryField
 
@@ -43,7 +52,10 @@ class UserStateSummaryFactory(DjangoModelFactory):  # lint-amnesty, pylint: disa
     usage_id = LOCATION('usage_id')
 
 
-class StudentPrefsFactory(DjangoModelFactory):  # lint-amnesty, pylint: disable=missing-class-docstring
+class StudentPrefsFactory(DjangoModelFactory):
+    """
+    Build XModuleStudentPrefsField models
+    """
     class Meta:
         model = XModuleStudentPrefsField
 
@@ -53,7 +65,10 @@ class StudentPrefsFactory(DjangoModelFactory):  # lint-amnesty, pylint: disable=
     module_type = 'mock_problem'
 
 
-class StudentInfoFactory(DjangoModelFactory):  # lint-amnesty, pylint: disable=missing-class-docstring
+class StudentInfoFactory(DjangoModelFactory):
+    """
+    Build XModuleStudentInfoField models
+    """
     class Meta:
         model = XModuleStudentInfoField