From ea26b22262e1c07540fd3151dade7e7603e2cadd Mon Sep 17 00:00:00 2001
From: tjhunt <tjhunt>
Date: Fri, 20 Mar 2009 07:41:49 +0000
Subject: [PATCH] accesslib. Improve comment.

---
 lib/accesslib.php | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/lib/accesslib.php b/lib/accesslib.php
index 7649541cf00..121811b007d 100755
--- a/lib/accesslib.php
+++ b/lib/accesslib.php
@@ -5369,17 +5369,16 @@ function get_roles_on_exact_context($context) {
  *
  * The caller *must* check
  * - that this op is allowed
- * - that the requested role can be assigned in this ctx
- *   (hint, use get_assignable_roles_for_switchrole())
+ * - that the requested role can be switched to in this context (use get_switchable_roles)
  * - that the requested role is NOT $CFG->defaultuserroleid
  *
  * To "unswitch" pass 0 as the roleid.
  *
  * This function *will* modify $USER->access - beware
  *
- * @param integer $roleid
- * @param object $context
- * @return bool
+ * @param integer $roleid the role to switch to.
+ * @param object $context the context in which to perform the switch.
+ * @return bool success or failure.
  */
 function role_switch($roleid, $context) {
     global $USER;