Add doc strings to module handlers (#3286)

* Add doc strings to handlers

* Remove spaces, typo

Co-authored-by: hwatheod <ted@learningu.org>

* Fix survey management doc string

Co-authored-by: hwatheod <ted@learningu.org>

esp/esp/program/modules/handlers/accountingmodule.py

@@ -39,6 +39,8 @@
 from esp.utils.web import render_to_response
 
 class AccountingModule(ProgramModuleObj):
+    doc = """Lists accounting information for the program for a single user."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/adminclass.py

@@ -53,7 +53,7 @@
 """ Module in the middle of a rewrite. -Michael """
 
 class AdminClass(ProgramModuleObj):
-    doc = """ This module is extremely useful for managing classes if you have them them in your program.
+    doc = """This module is extremely useful for managing classes if you have them in your program.
         Works best with student and teacher class modules, but they are not necessary.
         Options for this are available on the main manage page.
         """

esp/esp/program/modules/handlers/admincore.py

@@ -60,6 +60,7 @@ class NewPermissionForm(forms.Form):
     end_date = forms.DateTimeField(label='Closing date/time', initial=None, widget=DateTimeWidget(), required=False)
 
 class AdminCore(ProgramModuleObj, CoreModule):
+    doc = """Includes the core views for managing a program (e.g. settings, dashboard)."""
 
     @classmethod
     def module_properties(cls):
@@ -76,7 +77,7 @@ def main(self, request, tl, one, two, module, extra, prog):
         context = {}
         modules = self.program.getModules(request.user, 'manage')
 
-        context['modules'] = modules
+        context['modules'] = sorted(modules, key = lambda pmo: pmo.module.link_title)
         context['one'] = one
         context['two'] = two
 

esp/esp/program/modules/handlers/adminreviewapps.py

@@ -46,6 +46,8 @@
 __all__ = ['AdminReviewApps']
 
 class AdminReviewApps(ProgramModuleObj):
+    doc = """View student applications and select students to be admitted for the program."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/adminvitals.py

@@ -38,8 +38,7 @@ class KeyDoesNotExist(Exception):
     pass
 
 class AdminVitals(ProgramModuleObj):
-    doc = """ This allows you to view the major numbers for your program on the main page.
-        This will present itself below the options in a neat little table. """
+    doc = """This allows you to view the major numbers for your program on the dashboard."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/admissionsdashboard.py

@@ -42,11 +42,8 @@
 import json
 
 class AdmissionsDashboard(ProgramModuleObj):
-    """
-    A dashboard for Junction core teachers to review applications for their class.
-
-    Not to be confused with TeacherReviewApps, the app questions module.
-    """
+    doc = """A dashboard for Junction core teachers to review applications for their class.
+    Not to be confused with TeacherReviewApps, the app questions module."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/ajaxschedulingmodule.py

@@ -52,7 +52,7 @@
 import calendar, time, datetime
 
 class AJAXSchedulingModule(ProgramModuleObj):
-    """ This program module allows teachers to indicate their availability for the program. """
+    doc = """Provides an application to use for scheduling classes."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/autoschedulerfrontendmodule.py

@@ -11,6 +11,7 @@
 
 
 class AutoschedulerFrontendModule(ProgramModuleObj):
+    doc = """Augments the AJAX scheduler, adding an interface to automatically schedule individual sections."""
 
     @classmethod
     def module_properties(cls):
@@ -112,6 +113,9 @@ def autoscheduler_save(self, request, tl, one, two, module, extra, prog):
     def autoscheduler_clear(self, request, tl, one, two, module, extra, prog):
         return {'response': [{'success': 'yes'}]}
 
+    def isStep(self):
+        return False
+
     class Meta:
         proxy = True
         app_label = 'modules'

esp/esp/program/modules/handlers/availabilitymodule.py

@@ -48,7 +48,7 @@
 
 
 class AvailabilityModule(ProgramModuleObj):
-    """ This program module allows teachers to indicate their availability for the program. """
+    doc = """This program module allows teachers to indicate their availability for the program."""
 
     @classmethod
     def module_properties(cls):
@@ -244,4 +244,3 @@ def isStep(self):
     class Meta:
         proxy = True
         app_label = 'modules'
-

esp/esp/program/modules/handlers/bigboardmodule.py

@@ -14,6 +14,7 @@
 
 
 class BigBoardModule(ProgramModuleObj):
+    doc = """Shows statistics about student registration that refresh automatically."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/bulkcreateaccountmodule.py

@@ -6,6 +6,7 @@
 import random
 
 class BulkCreateAccountModule(ProgramModuleObj):
+    doc = """Create a bulk set of accounts (e.g. for outreach)."""
 
     MAX_PREFIX_LENGTH = 30
     MAX_NUMBER_OF_ACCOUNTS = 1000  # backstop so that an errant request can't fill up the DB with accounts

esp/esp/program/modules/handlers/checkavailabilitymodule.py

@@ -41,7 +41,7 @@
 
 
 class CheckAvailabilityModule(ProgramModuleObj):
-    """ This program module allows admins to check a teacher's availability for the program. """
+    doc = """Check a teacher's availability for the program."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/classsearchmodule.py

@@ -19,7 +19,8 @@
 
 
 class ClassSearchModule(ProgramModuleObj):
-    """Search for classes matching certain criteria."""
+    doc = """Search for classes matching certain criteria."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/commmodule.py

@@ -47,6 +47,7 @@
 from esp.middleware import ESPError
 
 class CommModule(ProgramModuleObj):
+    doc = """Email users that match specific search criteria."""
     """ Want to email all ESP students within a 60 mile radius of NYC?
     How about emailing all esp users within a 30 mile radius of New Hampshire whose last name contains 'e' and 'a'?
     Do that and even more useful things in the communication panel.

esp/esp/program/modules/handlers/creditcardmodule_cybersource.py

@@ -44,6 +44,8 @@
 from esp.middleware.threadlocalrequest import get_current_request
 
 class CreditCardModule_Cybersource(ProgramModuleObj):
+    doc = """Accept credit card payments via Cybersource."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/creditcardmodule_stripe.py

@@ -53,6 +53,8 @@
 import re
 
 class CreditCardModule_Stripe(ProgramModuleObj):
+    doc = """Accept credit card payments via Stripe."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/creditcardviewer.py

@@ -38,6 +38,8 @@
 from argcache            import cache_function
 
 class CreditCardViewer(ProgramModuleObj):
+    doc = """Lists the credit card payments for the program."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/customformmodule.py

@@ -50,6 +50,7 @@
 import re
 
 class CustomFormModule(ProgramModuleObj):
+    doc = """Serve a custom form as part of student and/or teacher registration."""
 
     def __init__(self, *args, **kwargs):
         super(CustomFormModule, self).__init__(*args, **kwargs)

esp/esp/program/modules/handlers/donationmodule.py

@@ -87,6 +87,7 @@ def clean_custom_amount(self):
 
 
 class DonationModule(ProgramModuleObj):
+    doc = """Solicit donations from students."""
 
     event = "donation_done"
 

esp/esp/program/modules/handlers/finaidapprovemodule.py

@@ -40,6 +40,8 @@
 
 
 class FinAidApproveModule(ProgramModuleObj):
+    doc = """View and approve student financial aid applications."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/financialaidappmodule.py

@@ -47,8 +47,9 @@
 from django              import forms
 
 
-# student class picker module
 class FinancialAidAppModule(ProgramModuleObj):
+    doc = """Serve a financial aid application to students."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/formstackappmodule.py

@@ -44,9 +44,8 @@
 from urllib import urlencode
 
 class FormstackAppModule(ProgramModuleObj):
-    """
+    doc = """
     Student application module for Junction.
-
     Not to be confused with StudentJunctionAppModule, the app questions module.
     """
 

esp/esp/program/modules/handlers/formstackmedliabmodule.py

@@ -45,7 +45,7 @@
 
 # hackish solution for Splash 2012
 class FormstackMedliabModule(ProgramModuleObj):
-    """ Module for collecting medical information online via Formstack """
+    doc = """Module for collecting medical information online via Formstack"""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/grouptextmodule.py

@@ -50,6 +50,7 @@
 from twilio.rest import TwilioRestClient
 
 class GroupTextModule(ProgramModuleObj):
+    doc = """Text users that match specific search criteria."""
     """ Want to tell all enrolled students about a last-minute lunch location
         change? Want to inform students about a cancelled class? The Group Text
         Panel is your friend!

esp/esp/program/modules/handlers/jsondatamodule.py

@@ -62,7 +62,7 @@
 from decimal import Decimal
 
 class JSONDataModule(ProgramModuleObj, CoreModule):
-    """ A program module dedicated to returning program-specific data in JSON form. """
+    doc = """A program module dedicated to returning program-specific data in JSON form."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/lineitemsmodule.py

@@ -39,6 +39,7 @@
 from esp.utils.web import render_to_response
 
 class LineItemsModule(ProgramModuleObj, CoreModule):
+    doc = """Create and/or edit line items for the program."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/listgenmodule.py

@@ -279,6 +279,7 @@ def __init__(self, *args, **kwargs):
         self.fields['fields'].initial = ['02_username','04_firstname','05_lastname','06_email']
 
 class ListGenModule(ProgramModuleObj):
+    doc = """Get information for users that match specific search criteria."""
     """ While far from complete, this will allow you to just generate a simple list of users matching a criteria (criteria very similar to the communications panel)."""
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/lotteryfrontendmodule.py

@@ -8,6 +8,7 @@
 from esp.utils.decorators import json_response
 
 class LotteryFrontendModule(ProgramModuleObj):
+    doc = """Run the class lottery and assign students to classes."""
 
     @classmethod
     def module_properties(cls):

esp/esp/program/modules/handlers/lotterystudentregmodule.py

@@ -59,6 +59,7 @@
 
 
 class LotteryStudentRegModule(ProgramModuleObj):
+    doc = """Allows students to enter a lottery for particular classes."""
 
     def students(self, QObject = False):
         q = Q(studentregistration__section__parent_class__parent_program=self.program) & nest_Q(StudentRegistration.is_valid_qobject(), 'studentregistration')

esp/esp/program/modules/handlers/mailinglabels.py

@@ -46,7 +46,7 @@
 
 
 class MailingLabels(ProgramModuleObj):
-    """ This allows one to generate Mailing Labels for both schools and users. You have the option of either creating a file which can be sent to MIT mailing services or actually create printable files.
+    doc = """This allows one to generate Mailing Labels for both schools and users. You have the option of either creating a file which can be sent to MIT mailing services or actually create printable files.
     """
 
     @classmethod

esp/esp/program/modules/handlers/mapgenmodule.py

@@ -44,7 +44,8 @@
 from collections import Counter
 
 class MapGenModule(ProgramModuleObj):
-    """ Allows you to generate a map showing the distribution of the selected users. """
+    doc = """Allows you to generate a map showing the distribution of the selected users."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/nametagmodule.py

@@ -47,7 +47,8 @@
 
 
 class NameTagModule(ProgramModuleObj):
-    """ This module allows you to generate a bunch of IDs for everyone in the program. """
+    doc = """This module allows you to generate a bunch of IDs for users that match specific criteria."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsiteattendance.py

@@ -50,6 +50,8 @@
 import datetime
 
 class OnSiteAttendance(ProgramModuleObj):
+    doc = """Provides statistics on program attendance and allows admins to take attendance for classes."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsitecheckinmodule.py

@@ -50,6 +50,8 @@
 
 
 class OnSiteCheckinModule(ProgramModuleObj):
+    doc = """Check in students for a program (including for payments and forms)."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsitecheckoutmodule.py

@@ -42,6 +42,8 @@
 from esp.middleware.esperrormiddleware import ESPError
 
 class OnSiteCheckoutModule(ProgramModuleObj):
+    doc = """Check students out (temporarily or indefinitely) from a program."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsiteclasslist.py

@@ -59,6 +59,8 @@
 from esp.accounting.controllers import IndividualAccountingController
 
 class OnSiteClassList(ProgramModuleObj):
+    doc = """Display lists of classes for onsite registration purposes."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsiteclassschedule.py

@@ -41,6 +41,8 @@
 from datetime         import datetime, timedelta
 
 class OnsiteClassSchedule(ProgramModuleObj):
+    doc = """Get and/or print a student's schedule for the program."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsitecore.py

@@ -42,6 +42,8 @@
 
 
 class OnsiteCore(ProgramModuleObj, CoreModule):
+    doc = """Serves the main onsite page."""
+
     @classmethod
     def module_properties(cls):
         return {
@@ -55,7 +57,7 @@ def module_properties(cls):
     @main_call
     @needs_onsite
     def main(self, request, tl, one, two, module, extra, prog):
-        """ Display a teacher eg page """
+        """ Display the onsite landing page """
         context = {}
         modules = self.program.getModules(request.user, 'onsite')
 

esp/esp/program/modules/handlers/onsitepaiditemsmodule.py

@@ -45,6 +45,8 @@
 
 
 class OnsitePaidItemsModule(ProgramModuleObj):
+    doc = """Lists the items that a student has requested/paid for."""
+
     @classmethod
     def module_properties(cls):
         return {

esp/esp/program/modules/handlers/onsiteprintschedules.py

@@ -47,6 +47,8 @@
 from django.template.loader import select_template
 
 class OnsitePrintSchedules(ProgramModuleObj):
+    doc = """Automatically print student schedules at onsite registration."""
+
     @classmethod
     def module_properties(cls):
         return {