Moodle Community Sites

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Component/s: docs.moodle.org
• Labels:

  None

Function has_capability_in_accessdata in lib/accesslib implements the algorithm that determines a user's permissions in a given context. The algorithm needs to be documented in docs.moodle.org.

There's even a To do in the code: "Document how it works"

Some developers believe that it is unnecessary for users to understand the algorithm. See http://moodle.org/mod/forum/discuss.php?d=90140. As someone who is frequently called upon to explain "edge" cases, I reject this position. If I can't get away with hand-waving, then neither can you!

Providing a set of examples (as suggested by Tim Hunt) is good, but not good enough.

Here's a suggestion: A developer who understands the code should write a pseudocode version of the algorithm and add it to the developer documentation. If it is written as a RECURSIVE function, it will be short and easy to understand by anyone with a programming background. Such people can use it as the basis for their own textual descriptions and examples.

• Assignee:

  Helen Foster

  Reporter:

  John Isner

  Participants:

  Helen Foster, John Isner, Petr Škoda (skodak)

• Created:

  16/Feb/08 4:34 AM

  Updated:

  02/Apr/08 5:02 PM

  Resolved:

  19/Mar/08 7:40 AM