Document local/lib.php functions

Bug #1314012 reported by Aaron Wells on 2014-04-29
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mahara
Low
Aaron Wells

Bug Description

See forum post: https://mahara.org/interaction/forum/editpost.php?parent=26592

There are quite a few local hooks that have been added to Mahara but are not documented in one central location. I've located these in the code, and added comments to local/lib.php that document the existence of these methods, so that a developer looking under /local/lib.php will know what their options are.

Reviewed: https://reviews.mahara.org/3296
Committed: http://gitorious.org/mahara/mahara/commit/36db800e13c5f3657785682ab669f727c4c88170
Submitter: Aaron Wells (<email address hidden>)
Branch: master

commit 36db800e13c5f3657785682ab669f727c4c88170
Author: Aaron Wells <email address hidden>
Date: Tue Apr 29 16:03:14 2014 +1200

Documenting all local/lib.php methods

Bug 1314012

Change-Id: I5e19266e8379fa1244cafafa147e20b7a23a0895

Aaron Wells (u-aaronw) on 2014-04-29
Changed in mahara:
status: In Progress → Fix Committed
milestone: none → 1.10.0
assignee: nobody → Aaron Wells (u-aaronw)
tags: added: local
Olli Puurunen (olli-puurunen-g) wrote :

Small error in the documentation. It says, that "local_header_top_content(): Returned data is printed at top of <head>", when in fact the returned data is printed (almost) at top of <body>.

Reviewed: https://reviews.mahara.org/3301
Committed: http://gitorious.org/mahara/mahara/commit/a6206ea26bd0ab17c2f726b02c864cf64572469a
Submitter: Aaron Wells (<email address hidden>)
Branch: master

commit a6206ea26bd0ab17c2f726b02c864cf64572469a
Author: Aaron Wells <email address hidden>
Date: Wed Apr 30 13:29:36 2014 +1200

Correction: local_header_top_content() actually prints in the page body

Bug 1314012

Change-Id: Ief2083df4e6781892c82d7f48cdbb23dc67ba4c0

Aaron Wells (u-aaronw) wrote :

Thanks Olli, I've changed the description to "Returned string (which may contain HTML) is printed near the top of each page."

Aaron Wells (u-aaronw) on 2014-10-21
Changed in mahara:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers