Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/bestpractical/rt.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Conry <bconry@bestpractical.com>2022-06-21 22:09:10 +0300
committerJim Brandt <jbrandt@bestpractical.com>2022-07-14 20:19:01 +0300
commit8d969f1c9245d5fa30f3823b7f15cc87c7068682 (patch)
tree87528480c408682b2cd987ed58b03a66b4425c5e
parent8cd02c8404e032dc9ed97ce13770d9d0c2a7577c (diff)
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.
-rw-r--r--lib/RT/Queue.pm14
1 files changed, 5 insertions, 9 deletions
diff --git a/lib/RT/Queue.pm b/lib/RT/Queue.pm
index 4e14217730..145294cb74 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.