Commit 282e787c authored by Olivier's avatar Olivier
Browse files

Module 6: move documentation to .md file, avoid duplicate info

* Move script documentation to markdown file, more accessible;
* Remove documentation from script preamble comment, to avoid
  duplicate information.
parent b85bd84a
Script: match_peers.py
======================
## Description
This script takes a list of the students who received customized assignments and the pdf files sent by them. Then it assigns two peers (reviewers) to each student, except to students that did not submit any solution to their assignment.
The output of the script is a `csv` file containing the consolidated data.
The input files should be placed in the `script_input` folder which is in the same path as the script. The output files will
be saved in the `script_output` folder.
## Script input
1. `output_assignments.csv`: This file contains the data from the students including their custom ID. It is the output file from the script [assign_customizer.py](../M2_customize_assignments/assign_customizer.py) from [module 2](../M2_customize_assignments).
1. All the `pdf` files with the solutions submitted by the students, named as: `submission_customID.pdf` (for example `submission_12345678.pdf`).
## Script output
1. `peers.csv`: file with the assigned peers for each student.
......@@ -2,28 +2,6 @@
"""
Author: German Santa Maria
Script: Match Peers
Description:
This script takes a list of the students who received customized assignments
and the pdf files sent by them. Then it assigns two peers (reviewers) to each
student except the ones that did not send any solution to the assignment. The
output of the scrip is a csv file containing the consolidated data.
Input:
1 - output_assignments.csv :
This file contains the data from the students including their custom ID
is the output file from the script "assign_customizer.py"
name lastname email matrikel custom_ID
Theodore Von Kárman example1@ovgu.de 123456 23344567
Osborne Reynolds example2@st.ovgu.de 123457 33445678
2 - All the pdf files with the solutions submitted by the students marked
as: “submission_customID.pdf”, for example: “submission_12345678.pdf”
Output:
1 - peers.csv : file with the assigned peers for each student
"""
"""-------------------------Hard coded input--------------------------------"""
......
Supports Markdown
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