Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-14901

misleading code documentation in print_navigation() from lib/weblib.php

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.9, 1.9.1
    • Fix Version/s: 1.9.5
    • Component/s: Documentation, Themes
    • Labels:
      None
    • Affected Branches:
      MOODLE_19_STABLE
    • Fixed Branches:
      MOODLE_19_STABLE

      Description

      Most of the code of this function is ignored. It justs uses the data that was prepared by the function build_navigation() and returns. So the parameter $separator is also ignored.
      When you edit a theme, you use this print_navigation() function in headers and footers. And after reading code documentation, you think you can easily change the separator in the breadcrumb.
      In fact you can't :
      print_navigation($navigation,' THEN');
      is the same as
      print_navigation($navigation);

      I suggest this $separator parameter should be documented as obsolete and generally meaningless. And by the way a short comment in the code would help.
      I hope I didn't misunderstood anything. Sorry if I'm wrong.

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Fix Release Date:
                13/May/09