Moodle

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

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor 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.

Activity

Hide
Helen Foster added a comment -

Reassigning to Eloy. Please reassign again if necessary.

Show
Helen Foster added a comment - Reassigning to Eloy. Please reassign again if necessary.
Hide
Tim Hunt added a comment -

Thanks for spotting this. I've now fixed it.

Note that themes probably should be able to control this, (although it was changed for good reasons to do with accessibility. See http://docs.moodle.org/en/Development:Navigation_2.0).

Show
Tim Hunt added a comment - Thanks for spotting this. I've now fixed it. Note that themes probably should be able to control this, (although it was changed for good reasons to do with accessibility. See http://docs.moodle.org/en/Development:Navigation_2.0).
Hide
Sam Hemelryk added a comment -

Noted commenting changed. Thanks Tim

Show
Sam Hemelryk added a comment - Noted commenting changed. Thanks Tim

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: