Merge branch 'master' of github.com:RunestoneInteractive/RunestoneServer

Author: bnmnetp

conf.py

@@ -337,9 +337,10 @@
 # This config value contains the locations and names of other projects that should be linked to in this documentation.
 intersphinx_mapping = {
     "RunestoneServer": (
-        "https://runestonecomponents.readthedocs.io/en/latest/",
-        None,
-        # An optional local file location -- useful when updating both Sphinx builds before the updates are pushed to the server.
-        ##"F:/Runestone/RunestoneComponents/build/RunestoneComponents/objects.inv",
+        "https://runestonecomponents.readthedocs.io/en/latest/", (
+            None,
+            # An optional local file location -- useful when updating both Sphinx builds before the updates are pushed to the server.
+            ##"C:/Users/bjones/Documents/git/RunestoneComponents/build/RunestoneComponents/objects.inv",
+        )
     )
 }

controllers/ajax.py

@@ -68,8 +68,15 @@ def compareAndUpdateCookieData(sid: str):
         )
 
 
+# Endpoints
+# =========
+#
+# .. _hsblog endpoint:
+#
+# hsblog endpoint
+# ---------------
 # Given a JSON record of a clickstream event record the event in the ``useinfo`` table.
-# If the event is an answer to a runestone qustion record that answer in the database in
+# If the event is an answer to a runestone question record that answer in the database in
 # one of the xxx_answers tables.
 #
 def hsblog():
@@ -327,6 +334,11 @@ def hsblog():
     return json.dumps(res)
 
 
+# .. _runlog endpoint:
+#
+# runlog endpoint
+# ---------------
+# The `logRunEvent` client-side function calls this endpoint to record TODO...
 def runlog():  # Log errors and runs with code
     # response.headers['content-type'] = 'application/json'
     setCookie = False

models/grouped_assignments.py

@@ -1,3 +1,7 @@
+# *************************************
+# |docname| - assignment-related tables
+# *************************************
+
 db.define_table(
     "assignments",
     Field("course", db.courses),
@@ -39,7 +43,7 @@
     Field("lis_result_sourcedid", "string", length=1024),
     # web service endpoint where you send signed xml messages to insert into gradebook; guid above will be one parameter you send in that xml; the actual grade and comment will be others
     #
-    # Per the ``LTI spec v1.1.1 <https://www.imsglobal.org/specs/ltiv1p1p1/implementation-guide>`_ in section 6, the maximum length of the ``lis_outcome_url`` field is 1023 characters.
+    # Per the `LTI spec v1.1.1 <https://www.imsglobal.org/specs/ltiv1p1p1/implementation-guide>`_ in section 6, the maximum length of the ``lis_outcome_url`` field is 1023 characters.
     Field("lis_outcome_url", "string", length=1024),
     migrate=table_migrate_prefix + "grades.table",
 )
@@ -57,6 +61,10 @@
 )
 
 
+# .. _question_grades table:
+#
+# question_grades
+# ===============
 db.define_table(
     "question_grades",
     # This table records grades on individual gradeable items

tests/conftest.py

@@ -952,7 +952,7 @@ def selenium_driver(selenium_driver_session):
 
     yield driver
 
-    # Clear as much as possible, to present an almost-fresh instance of a browser for the next test. (Shutting down then starting up a browswer is very slow.)
+    # Clear as much as possible, to present an almost-fresh instance of a browser for the next test. (Shutting down then starting up a browser is very slow.)
     driver.execute_script("window.localStorage.clear();")
     driver.execute_script("window.sessionStorage.clear();")
     driver.delete_all_cookies()