From 405840c8c89a46163cdc39586140510804ed943f Mon Sep 17 00:00:00 2001 From: Ben Warzeski Date: Tue, 12 Sep 2023 17:12:06 +0000 Subject: [PATCH] chore: assessment api module docstrings --- openassessment/xblock/apis/assessments/peer_assessment_api.py | 3 +++ openassessment/xblock/apis/assessments/self_assessment_api.py | 3 +++ openassessment/xblock/apis/assessments/staff_assessment_api.py | 3 +++ openassessment/xblock/apis/assessments/student_training_api.py | 3 +++ 4 files changed, 12 insertions(+) diff --git a/openassessment/xblock/apis/assessments/peer_assessment_api.py b/openassessment/xblock/apis/assessments/peer_assessment_api.py index 85010c3f06..e628f47933 100644 --- 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 index 8a203d7331..6764b10d97 100644 --- 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 index 2fe0a9d913..f1c1c4ec99 100644 --- 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 index bd562ddd0b..a850cbdc9a 100644 --- 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,