Moodle Community Sites

Rewrite the documentation of moodle/site:readallmessages

Details

  • Type: Improvement Improvement
  • Status: Resolved Resolved
  • Priority: Minor Minor
  • Resolution: Fixed
  • Component/s: docs.moodle.org
  • Labels:
    None

Description

The current documentation for moodle/site:readallmessages in http://docs.moodle.org/en/Capabilities/moodle/site:readallmessages reads

  • This allows a user to read all messages in the given context
  • The default Teacher role has this capability set to allow to enable them to send messages to more than one user via the participants page

The meaning is unclear, even after experimenting and trying to read the code. What does exactly does it mean by "read all messages?" (The first bullet amounts to a circular definition) And why does a capability called "readallmessages" affect a user's ability to SEND messages?

Can someone please rewrite this?

General comments about capability definitions in docs:

  • the phrase "in the given context" is implicit in every capability definition. It does not need to be stated explicitly
  • Why mention the default [sic] Teacher role? A capability definition should only describe the action that the capability controls. If you're going to mention a specific role, use them only as examples, not as part of the definition (i.e., not to define the behavior).

I have been going through the capability definitions in docs one by one. This one is the first I have encountered that tells me absolutely nothing.

Activity

Hide
Helen Foster added a comment -

Documentation updated. John, thanks for your report.

Show
Helen Foster added a comment - Documentation updated. John, thanks for your report.

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: