editing function description

helenacuesta · Dec 14, 2020 · 67d7327 · 67d7327
1 parent 9b4ea52
commit 67d7327
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/assessment.py b/assessment.py
@@ -185,11 +185,15 @@ def intonation_assessment(startbar, endbar, offset, pitch_path, score_path, voic
 
     voice : (string) voice part as written in the score
 
+    assessment : (dictionary) empty python dictionary with two fields 'pitchAssessment' set to an empty list
+    and 'error' set to None.
+
     dev_thresh : (float) maximum allowed deviation in cents. Defaults to 100 cents
 
     Returns
     -------
-    assessment : (dictionary) with the assessment results for each note in the 'pitchAssessment' field \n
+    assessment : (dictionary) with the assessment results for each note in the 'pitchAssessment' field and and 'error'
+    field.
     overall_score : (float) overall intonation score computed as the weighted sum of note intonation scores
 
     '''