From 8d969f1c9245d5fa30f3823b7f15cc87c7068682 Mon Sep 17 00:00:00 2001 From: Brian Conry Date: Tue, 21 Jun 2022 14:09:10 -0500 Subject: [PATCH] Fix docs on RT::Queue::IsWatcher The documentation incorrectly states that it can check for the Type of Owner and Requestor, but the method cannot. The incorrect documentation was copied from RT::Ticket, which does have those Types. --- lib/RT/Queue.pm | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/lib/RT/Queue.pm b/lib/RT/Queue.pm index 4e14217730f..145294cb74f 100644 --- a/lib/RT/Queue.pm +++ b/lib/RT/Queue.pm @@ -664,19 +664,17 @@ sub AdminCc { } - -# a generic routine to be called by IsRequestor, IsCc and IsAdminCc +# a generic routine to be called by IsCc and IsAdminCc =head2 IsWatcher { Type => TYPE, PrincipalId => PRINCIPAL_ID } -Takes a param hash with the attributes Type and PrincipalId - -Type is one of Requestor, Cc, AdminCc and Owner +Takes a param hash with the attributes Type and PrincipalId. -PrincipalId is an RT::Principal id +Type is one of Cc or AdminCc. -Returns true if that principal is a member of the group Type for this queue +PrincipalId is an RT::Principal id. +Returns true if that principal is a member of the group Type for this queue. =cut @@ -702,8 +700,6 @@ sub IsWatcher { } - - =head2 IsCc PRINCIPAL_ID Takes an RT::Principal id.