chore: assessment api module docstrings

openedx · Sep 12, 2023 · 405840c · 405840c
1 parent 1f8ffe3
commit 405840c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/openassessment/xblock/apis/assessments/peer_assessment_api.py b/openassessment/xblock/apis/assessments/peer_assessment_api.py
@@ -1,3 +1,6 @@
+"""
+External API for ORA Peer Assessment data
+"""
 import logging
 
 from openassessment.assessment.errors import PeerAssessmentWorkflowError

diff --git a/openassessment/xblock/apis/assessments/self_assessment_api.py b/openassessment/xblock/apis/assessments/self_assessment_api.py
@@ -1,3 +1,6 @@
+"""
+External API for ORA Self Assessment data
+"""
 from submissions import api as submission_api
 
 from openassessment.assessment.api import self as self_api

diff --git a/openassessment/xblock/apis/assessments/staff_assessment_api.py b/openassessment/xblock/apis/assessments/staff_assessment_api.py
@@ -1,3 +1,6 @@
+"""
+External API for ORA Staff Assessment data
+"""
 from submissions import team_api as team_sub_api
 
 from openassessment.assessment.api import staff as staff_api, teams as teams_api

diff --git a/openassessment/xblock/apis/assessments/student_training_api.py b/openassessment/xblock/apis/assessments/student_training_api.py
@@ -1,3 +1,6 @@
+"""
+External API for ORA Student Training data
+"""
 from openassessment.assessment.api.student_training import (
     get_num_completed,
     get_training_example,