MDL-36805 Correct docs for workshop_grade_item_update in mod_workshop
authorAndrew Robert Nicols <andrew.nicols@luns.net.uk>
Fri, 23 Nov 2012 15:49:15 +0000 (15:49 +0000)
committerAndrew Robert Nicols <andrew.nicols@luns.net.uk>
Mon, 10 Dec 2012 12:27:30 +0000 (12:27 +0000)
The documentation suggested that the modname field should be present on the
$workshop parameter when this is not required. It is not used in any point
in the function and the $workshop variable is never passed to another
function which may use it.

mod/workshop/lib.php

index 1508b5b..cf37a23 100644 (file)
@@ -1035,7 +1035,7 @@ function workshop_get_extra_capabilities() {
  * Needed by grade_update_mod_grades() in lib/gradelib.php. Also used by
  * {@link workshop_update_grades()}.
  *
  * Needed by grade_update_mod_grades() in lib/gradelib.php. Also used by
  * {@link workshop_update_grades()}.
  *
- * @param stdClass $workshop instance object with extra cmidnumber and modname property
+ * @param stdClass $workshop instance object with extra cmidnumber property
  * @param stdClass $submissiongrades data for the first grade item
  * @param stdClass $assessmentgrades data for the second grade item
  * @return void
  * @param stdClass $submissiongrades data for the first grade item
  * @param stdClass $assessmentgrades data for the second grade item
  * @return void