Issue Details (XML | Word | Printable)

Key: MDL-14901
Type: Improvement Improvement
Status: Closed Closed
Resolution: Fixed
Priority: Minor Minor
Assignee: Tim Hunt
Reporter: François Gannaz
Votes: 0
Watchers: 0
Operations

Add/Edit UI Mockup to this issue
If you were logged in you would be able to see more operations.
Moodle

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

Created: 19/May/08 08:13 PM   Updated: 10/Jun/09 11:50 AM
Component/s: Documentation, Themes
Affects Version/s: 1.9, 1.9.1
Fix Version/s: 1.9.5

Participants: François Gannaz, Helen Foster, Sam Hemelryk and Tim Hunt
Security Level: None
QA Assignee: Sam Hemelryk
Resolved date: 04/Feb/09
Affected Branches: MOODLE_19_STABLE
Fixed Branches: MOODLE_19_STABLE


 Description  « Hide
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.



 All   Comments   Change History   Version Control      Sort Order: Ascending order - Click to sort in descending order
Helen Foster added a comment - 02/Jun/08 08:36 PM
Reassigning to Eloy. Please reassign again if necessary.

Tim Hunt added a comment - 04/Feb/09 04:35 PM
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).


Sam Hemelryk added a comment - 10/Jun/09 11:50 AM
Noted commenting changed. Thanks Tim