Skip to content

Commit

Permalink
Fix docs on RT::Queue::IsWatcher
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bconry-bps authored and cbrandtbuffalo committed Jul 14, 2022
1 parent 8cd02c8 commit 8d969f1
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions lib/RT/Queue.pm
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -702,8 +700,6 @@ sub IsWatcher {
}




=head2 IsCc PRINCIPAL_ID
Takes an RT::Principal id.
Expand Down

0 comments on commit 8d969f1

Please sign in to comment.