Update classes/helper.php

Co-authored-by: PhMemmel <[email protected]>
mebis-lp · Jan 15, 2025 · 5a412e8 · 5a412e8
1 parent 9f2d931
commit 5a412e8
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/classes/helper.php b/classes/helper.php
@@ -26,10 +26,11 @@
 class helper {
     /**
      * Returns whether the map should be shown on the course page.
-     * If course format is format_learningmap the setting in the database is ignored.
      *
-     * @param cm_info $cm
-     * @return bool
+     * If course format format_learningmap is being used the module setting will be ignored.
+     *
+     * @param cm_info $cm the coursemodule info object
+     * @return bool the "showoncoursemap" setting of the coursemodule, or false if current course format is format_learningmap
      */
     public static function show_map_on_course_page($cm): bool {
         global $DB;