Commit dfc40092 by Stephen Sanchez

Getting the docstrings to work.

parent deb91dbf
...@@ -10,7 +10,8 @@ Contents: ...@@ -10,7 +10,8 @@ Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
.. automodule:: api
:members:
Indices and tables Indices and tables
......
def get_next_submission(student_id, location): def get_next_submission(student_id, location):
""" """Request the next submission to be peer graded.
Request the next submission to be peer graded.
Args: Args:
student_id(str): The student requesting to grade a peer. Must check to determine if the requesting student has student_id (str): The student requesting to grade a peer. Must check to determine if the requesting student has
submitted an answer of their own. submitted an answer of their own.
location(str): The associated location for the submission to be graded. location (str): The associated location for the submission to be graded.
Returns: Returns:
Submission: The submission to grade, if one is available. Submission: The submission to grade, if one is available.
""" """
pass pass
def get_last_submission(student_id, location): def get_last_submission(student_id, location):
""" """Used to give visibility to scoring and workflow for a submission in peer grading.
Used to give visibility to scoring and workflow for a submission in peer grading. If the student has submitted a
submission and has graded enough peers, this function will return the submission as is, with all available scoring If the student has submitted a submission and has graded enough peers, this function will return the submission as
data. If the student has not finished grading peers, scoring information on their submission is withheld. is, with all available scoring data. If the student has not finished grading peers, scoring information on their
submission is withheld.
Args: Args:
student_id (str): The student. student_id (str): The student.
location (str): The associated location. location (str): The associated location.
Returns: Returns:
Submission: The student's latest submission, restrained on workflow completion. Submission: The student's latest submission, restrained on workflow completion.
""" """
pass pass
def submit_submission(submission): def submit_submission(submission):
""" """Submit a submission for peer grading.
Submit a submission for peer grading.
Args: Args:
submission (Submission): The submission to add to the peer grading queue. Should contain the student_id, submission (Submission): The submission to add to the peer grading queue. Should contain the student_id,
associated location, and all answer related fields prepopulated. Submission date, associated location, and all answer related fields prepopulated. Submission date,
preferred grader, and other attributes can be determined internally. preferred grader, and other attributes can be determined internally.
Returns: Returns:
Submission: The saved submission. Submission: The saved submission.
""" """
...@@ -41,12 +45,13 @@ def submit_submission(submission): ...@@ -41,12 +45,13 @@ def submit_submission(submission):
def submit_score(scoring, submission): def submit_score(scoring, submission):
""" """Submit a scoring for a particular submission
Submit a scoring for a particular submission
Args: Args:
scoring (Scoring): The score for a particular submission. scoring (Scoring): The score for a particular submission.
submission (Submission): The associated submission. submission (Submission): The associated submission.
Returns: Returns:
bool: True if the submission succeeded. bool: True if the submission succeeded.
""" """
pass pass
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment