From bc5e238ff8910540dfa4f576b3031f9755f350a6 Mon Sep 17 00:00:00 2001 From: Molae Date: Tue, 7 Oct 2025 12:19:40 +0000 Subject: [PATCH] chore: adjust revoke all access description --- .../course_access/src/functions/revoke_all_access.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/contracts/course/course_access/src/functions/revoke_all_access.rs b/contracts/course/course_access/src/functions/revoke_all_access.rs index e33b902..4d5b548 100644 --- a/contracts/course/course_access/src/functions/revoke_all_access.rs +++ b/contracts/course/course_access/src/functions/revoke_all_access.rs @@ -16,6 +16,17 @@ const COURSES_KEY: Symbol = symbol_short!("courses"); const REVOKE_ALL_EVENT: Symbol = symbol_short!("revokeAll"); +/// Description: Revokes all user access to a specific course. Only callable by an admin or the course creator. +/// +/// # Arguments +/// +/// * env - The contract environment. +/// * caller - The address of the caller requesting the revoke operation. +/// * course_id - The unique identifier of the course for which access is being revoked. +/// +/// # Returns +/// +/// * Result - Returns the number of users whose access was revoked (Ok), or an error if the operation fails (Err). pub fn revoke_all_access(env: Env, caller: Address, course_id: String) -> u32 { caller.require_auth();