[Rt-commit] rt branch, 4.0/pod-spell, updated. rt-4.0.0rc6-174-g4b98652
Shawn Moore
sartak at bestpractical.com
Thu Mar 17 21:01:47 EDT 2011
The branch, 4.0/pod-spell has been updated
via 4b98652980e06c0d8c87812a79b300d531ed35ce (commit)
via eae12c384d1bc5931b765175db2dbc4ba380c59a (commit)
via bdde70f65dd688fc6b2da22ceccd45305f7bb1ff (commit)
via d80feb7b77ff6cad201d091b308ab97e725c3d2a (commit)
via d5e07ec9d38a9bc0d30ad69133ff3942f6a277d9 (commit)
via 2159b664d7af6bea012350c638b87730e5eadb9b (commit)
via 779848e4d2ee97d70e79180cfca0b5a3ca5ad75e (commit)
from 48f5cfbebe2348d38d350902d9a4ee030552bdc0 (commit)
Summary of changes:
lib/RT/System.pm | 2 +-
lib/RT/Template.pm | 14 +++++-----
lib/RT/Ticket.pm | 44 ++++++++++++++++---------------
lib/RT/Tickets.pm | 69 +++++++++++++++++++++++++------------------------
lib/RT/Transaction.pm | 10 +++---
lib/RT/URI.pm | 8 +++---
lib/RT/User.pm | 55 +++++++++++++++++++++++---------------
t/99-pod-spelling.t | 3 ++
8 files changed, 111 insertions(+), 94 deletions(-)
- Log -----------------------------------------------------------------
commit 779848e4d2ee97d70e79180cfca0b5a3ca5ad75e
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 20:18:57 2011 -0400
Spellcheck lib/RT/System.pm
diff --git a/lib/RT/System.pm b/lib/RT/System.pm
index 62289f0..1154864 100644
--- a/lib/RT/System.pm
+++ b/lib/RT/System.pm
@@ -240,7 +240,7 @@ sub SubjectTag {
Attribute to decide when SelectQueue needs to flush the list of queues
and retrieve new ones. Set when queues are created, enabled/disabled
-and on certain acl changes. Should also better understand group management.
+and on certain ACL changes. Should also better understand group management.
If passed a true value, will update the attribute to be the current time.
commit 2159b664d7af6bea012350c638b87730e5eadb9b
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 20:20:40 2011 -0400
Spellcheck lib/RT/Template.pm
diff --git a/lib/RT/Template.pm b/lib/RT/Template.pm
index 6f0251d..72b8991 100644
--- a/lib/RT/Template.pm
+++ b/lib/RT/Template.pm
@@ -161,7 +161,7 @@ sub LoadGlobalTemplate {
Loads the Queue template named NAME for Queue QUEUE.
Note that this method doesn't load a global template with the same name
-if template in the queue doesn't exist. THe following code can be used:
+if template in the queue doesn't exist. The following code can be used:
$template->LoadQueueTemplate( Queue => $queue_id, Name => $template_name );
unless ( $template->id ) {
@@ -489,7 +489,7 @@ sub _ParseContentSimple {
$fi_text =~ s/^\s+//;
$fi_text =~ s/\s+$//;
- # if the codeblock is a simple $Variable lookup, use the value from
+ # if the code block is a simple $Variable lookup, use the value from
# the TemplateArgs hash...
if (my ($var) = $fi_text =~ /^\$(\w+)$/) {
if (exists $args{TemplateArgs}{$var}) {
@@ -497,7 +497,7 @@ sub _ParseContentSimple {
}
}
- # if there was no substitution then just reinsert the codeblock
+ # if there was no substitution then just reinsert the code block
if (!defined $fi_res) {
$fi_res = "{$original_fi_text}";
}
@@ -652,11 +652,11 @@ sub _UpdateAttributes {
=head2 CompileCheck
-If the template's Type is Perl, then compile check all the codeblocks to see if
-they are syntactically valid. We eval them in a codeblock to avoid actually
+If the template's Type is Perl, then compile check all the code blocks to see if
+they are syntactically valid. We eval them in a code block to avoid actually
executing the code.
-Returns an (ok, message) pair.
+Returns an (OK, message) pair.
=cut
@@ -693,7 +693,7 @@ sub CompileCheck {
# all the other extraneous garbage
$error =~ s/\(eval \d+\) line (\d+).*/"template line " . ($1+$fi_lineno-1)/es;
- return (0, $self->loc("Couldn't compile template codeblock '[_1]': [_2]", $fi_text, $error));
+ return (0, $self->loc("Couldn't compile template code block '[_1]': [_2]", $fi_text, $error));
}
return (1, $self->loc("Template compiles"));
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index cbbf7ca..b60f093 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -102,6 +102,7 @@ codebase
add-ons
subcomponents
unary
+UTF-8
# RT JARGON
ACEs
commit d5e07ec9d38a9bc0d30ad69133ff3942f6a277d9
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 20:28:52 2011 -0400
Spellcheck lib/RT/Ticket.pm
diff --git a/lib/RT/Ticket.pm b/lib/RT/Ticket.pm
index 3ad34cc..9cbba97 100644
--- a/lib/RT/Ticket.pm
+++ b/lib/RT/Ticket.pm
@@ -140,7 +140,7 @@ our %MERGE_CACHE = (
=head2 Load
Takes a single argument. This can be a ticket id, ticket alias or
-local ticket uri. If the ticket can't be loaded, returns undef.
+local ticket URI. If the ticket can't be loaded, returns undef.
Otherwise, returns the ticket id.
=cut
@@ -211,7 +211,7 @@ Arguments: ARGS is a hash of named parameters. Valid parameters are:
MIMEObj -- a MIME::Entity object with the content of the initial ticket request.
CustomField-<n> -- a scalar or array of values for the customfield with the id <n>
-Ticket links can be set up during create by passing the link type as a hask key and
+Ticket links can be set up during create by passing the link type as a hash key and
the ticket id to be linked to as a value (or a URI when linking to other objects).
Multiple links of the same type can be created by passing an array ref. For example:
@@ -1029,9 +1029,9 @@ Type One of Requestor, Cc, AdminCc
PrincipalId The RT::Principal id of the user or group that's being added as a watcher
Email The email address of the new watcher. If a user with this
- email address can't be found, a new nonprivileged user will be created.
+ email address can't be found, a new unprivileged user will be created.
-If the watcher you\'re trying to set has an RT account, set the PrincipalId paremeter to their User Id. Otherwise, set the Email parameter to their Email address.
+If the watcher you're trying to set has an RT account, this sets the PrincipalId parameter to their User Id. Otherwise, sets the Email parameter to their Email address.
=cut
@@ -1088,7 +1088,7 @@ sub AddWatcher {
}
#This contains the meat of AddWatcher. but can be called from a routine like
-# Create, which doesn't need the additional acl check
+# Create, which doesn't need the additional ACL check.
sub _AddWatcher {
my $self = shift;
my %args = (
@@ -1171,7 +1171,7 @@ and one of
PrincipalId (an RT::Principal Id of the watcher you want to remove)
OR
-Email (the email address of an existing wathcer)
+Email (the email address of an existing watcher)
=cut
@@ -1467,7 +1467,7 @@ sub AdminCc {
=head2 IsWatcher { Type => TYPE, PrincipalId => PRINCIPAL_ID, Email => EMAIL }
-Takes a param hash with the attributes Type and either PrincipalId or Email
+Takes a paramhash with the attributes Type and either PrincipalId or Email
Type is one of Requestor, Cc, AdminCc and Owner
@@ -1577,7 +1577,7 @@ sub IsOwner {
my $self = shift;
my $person = shift;
- # no ACL check since this is used in acl decisions
+ # no ACL check since this is used in ACL decisions
# unless ($self->CurrentUserHasRight('ShowTicket')) {
# return(undef);
# }
@@ -1605,7 +1605,7 @@ Returns a composite hashref of the results of L<RT::Transaction/Addresses> for
all this ticket's Create, Comment or Correspond transactions. The keys are
stringified email addresses. Each value is an L<Email::Address> object.
-NOTE: For performance reasons, this method might want to skip transactions and go straight for attachments. But to make that work right, we're going to need to go and walk around the access control in Attachment.pm's sub _Value.
+NOTE: For performance reasons, this method might want to skip transactions and go straight for attachments. But to make that work right, we're going to need to go and walk around the access control in L<RT::Attachment/_Value>.
=cut
@@ -1809,7 +1809,7 @@ sub QueueObj {
=head2 SubjectTag
Takes nothing. Returns SubjectTag for this ticket. Includes
-queue's subject tag or rtname if that is not set, ticket
+queue's subject tag or the configured C<rtname> if that is not set, ticket
id and braces, for example:
[support.example.com #123456]
@@ -2271,7 +2271,7 @@ sub DryRun {
=head2 DryRunCreate
-Prepares a MIME mesage with the given C<Subject>, C<Cc>, and
+Prepares a MIME message with the given C<Subject>, C<Cc>, and
C<Content>, then calls L</Create> with C<< DryRun => 1 >> and returns
the resulting L<RT::Transaction>.
@@ -2524,7 +2524,7 @@ sub __GetTicketFromURI {
=head2 _AddLink
-Private non-acled variant of AddLink so that links can be added during create.
+Private non-ACL-checked variant of AddLink so that links can be added during create.
=cut
@@ -2947,7 +2947,7 @@ sub SetOwner {
Value => $NewOwnerObj->Id,
TimeTaken => 0,
TransactionType => 'Set',
- CheckACL => 0, # don't check acl
+ CheckACL => 0, # don't check ACL
);
unless ($val) {
@@ -2981,7 +2981,7 @@ sub SetOwner {
=head2 Take
-A convenince method to set the ticket's owner to the current user
+A convenience method to set the ticket's owner to the current user
=cut
@@ -3187,7 +3187,7 @@ sub SetTold {
=head2 _SetTold
-Updates the told without a transaction or acl check. Useful when we're sending replies.
+Updates the told without a transaction or ACL check. Useful when we're sending replies.
=cut
@@ -3244,8 +3244,9 @@ sub TransactionBatch {
=head2 ApplyTransactionBatch
-Applies scrips on the current batch of transactions and shinks it. Usually
-batch is applied when object is destroyed, but in some cases it's too late.
+Executes scrips on the current batch of transactions, and clears the batched
+scrips. Usually the batch is applied when the object is L</DESTROY>ed, but in some
+cases that is too late.
=cut
@@ -3440,8 +3441,8 @@ sub _Value {
=head2 _UpdateTimeTaken
-This routine will increment the timeworked counter. it should
-only be called from _NewTransaction
+This routine will increment the TimeWorked counter. It should
+only be called from L</_NewTransaction>.
=cut
@@ -3520,8 +3521,9 @@ sub HasRight {
=head2 Reminders
-Return the Reminders object for this ticket. (It's an RT::Reminders object.)
-It isn't acutally a searchbuilder collection itself.
+Return the L<RT::Reminders> object for this ticket.
+
+It isn't actually a L<DBIx::SearchBuilder> collection.
=cut
commit d80feb7b77ff6cad201d091b308ab97e725c3d2a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 20:31:58 2011 -0400
Spellcheck lib/RT/Tickets.pm
diff --git a/lib/RT/Tickets.pm b/lib/RT/Tickets.pm
index 99b43a8..0050f56 100644
--- a/lib/RT/Tickets.pm
+++ b/lib/RT/Tickets.pm
@@ -616,7 +616,7 @@ sub _StringLimit {
Handle fields limiting based on Transaction Date.
-The inpupt value must be in a format parseable by Time::ParseDate
+We use L<Time::ParseDate> to parse the input value into a format we can use.
Meta Data:
None
@@ -1121,34 +1121,35 @@ specific group or not.
Meta Data:
1: Field to query on
-SELECT DISTINCT main.*
-FROM
- Tickets main,
- Groups Groups_1,
- CachedGroupMembers CachedGroupMembers_2,
- Users Users_3
-WHERE (
- (main.EffectiveId = main.id)
-) AND (
- (main.Status != 'deleted')
-) AND (
- (main.Type = 'ticket')
-) AND (
- (
- (Users_3.EmailAddress = '22')
- AND
- (Groups_1.Domain = 'RT::Ticket-Role')
- AND
- (Groups_1.Type = 'RequestorGroup')
- )
-) AND
- Groups_1.Instance = main.id
-AND
- Groups_1.id = CachedGroupMembers_2.GroupId
-AND
- CachedGroupMembers_2.MemberId = Users_3.id
-ORDER BY main.id ASC
-LIMIT 25
+
+ SELECT DISTINCT main.*
+ FROM
+ Tickets main,
+ Groups Groups_1,
+ CachedGroupMembers CachedGroupMembers_2,
+ Users Users_3
+ WHERE (
+ (main.EffectiveId = main.id)
+ ) AND (
+ (main.Status != 'deleted')
+ ) AND (
+ (main.Type = 'ticket')
+ ) AND (
+ (
+ (Users_3.EmailAddress = '22')
+ AND
+ (Groups_1.Domain = 'RT::Ticket-Role')
+ AND
+ (Groups_1.Type = 'RequestorGroup')
+ )
+ ) AND
+ Groups_1.Instance = main.id
+ AND
+ Groups_1.id = CachedGroupMembers_2.GroupId
+ AND
+ CachedGroupMembers_2.MemberId = Users_3.id
+ ORDER BY main.id ASC
+ LIMIT 25
=cut
@@ -1245,7 +1246,7 @@ sub _WatcherMembershipLimit {
=head2 _CustomFieldDecipher
-Try and turn a CF descriptor into (cfid, cfname) object pair.
+Try to turn a CF descriptor into an (id, name) object pair.
=cut
@@ -2711,11 +2712,11 @@ Takes a paramhash of key/value pairs with the following keys:
=over 4
-=item CUSTOMFIELD - CustomField name or id. If a name is passed, an additional parameter QUEUE may also be passed to distinguish the custom field.
+=item C<CUSTOMFIELD> - CustomField name or id. If a name is passed, an additional parameter QUEUE may also be passed to distinguish the custom field.
-=item OPERATOR - The usual Limit operators
+=item C<OPERATOR> - The usual Limit operators
-=item VALUE - The value to compare against
+=item C<VALUE> - The value to compare against
=back
@@ -3389,7 +3390,7 @@ sub _ProcessRestrictions {
=head2 _BuildItemMap
Build up a L</ItemMap> of first/last/next/prev items, so that we can
-display search nav quickly.
+display search navigation quickly.
=cut
commit bdde70f65dd688fc6b2da22ceccd45305f7bb1ff
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 20:51:38 2011 -0400
Spellcheck lib/RT/Transaction.pm
diff --git a/lib/RT/Transaction.pm b/lib/RT/Transaction.pm
index 2baccc2..b512f8a 100644
--- a/lib/RT/Transaction.pm
+++ b/lib/RT/Transaction.pm
@@ -239,7 +239,7 @@ sub Rules {
=head2 Delete
-Delete this transaction. Currently DOES NOT CHECK ACLS
+Delete this transaction. B<Currently does not check ACLs!>
=cut
@@ -1048,9 +1048,9 @@ sub CurrentUserHasRight {
Returns true if current user has rights to see this particular transaction.
-This fact depends on type of the transaction, type of an object the transaction
-is attached to and may be other conditions, so this method is prefered over
-custom implementations.
+This fact depends on the type of the transaction, the type of the object that
+the transaction is attached to and maybe other conditions, so this method is
+preferred over custom implementations.
=cut
@@ -1291,7 +1291,7 @@ Takes the following arguments:
=over
-=item * a string to indicate the frequency of digest delivery. Valid values are "daily", "weekly", or "susp".
+=item * a string to indicate the frequency of digest delivery. Valid values are "C<daily>", "C<weekly>", or "C<susp>".
=item * an optional argument which, if true, will return addresses even if this notification has been marked as 'sent' for this transaction.
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index b60f093..189c5ec 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -103,6 +103,7 @@ add-ons
subcomponents
unary
UTF-8
+reparenting
# RT JARGON
ACEs
commit eae12c384d1bc5931b765175db2dbc4ba380c59a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 20:54:29 2011 -0400
Spellcheck lib/RT/URI.pm
diff --git a/lib/RT/URI.pm b/lib/RT/URI.pm
index 790a830..f03dcba 100644
--- a/lib/RT/URI.pm
+++ b/lib/RT/URI.pm
@@ -116,7 +116,7 @@ sub FromObject {
Returns a local object id for this content. You are expected to know
what sort of object this is the Id of
-Returns true if everything is ok, otherwise false
+Returns true if everything is okay, otherwise false.
=cut
@@ -216,7 +216,7 @@ sub URI {
=head2 Object
-Returns a local object for this content. This will usually be an RT::Ticket or somesuch
+Returns a local object for this content. This will usually be an L<RT::Ticket>.
=cut
@@ -232,7 +232,7 @@ sub Object {
=head2 IsLocal
-Returns a local object for this content. This will usually be an RT::Ticket or somesuch
+Returns whether the object is governed by this instance of RT.
=cut
@@ -256,7 +256,7 @@ sub AsHREF {
=head2 Resolver
-Returns this URI's URI resolver object
+Returns this object's URI resolver object.
=cut
commit 4b98652980e06c0d8c87812a79b300d531ed35ce
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 21:01:40 2011 -0400
Spellcheck lib/RT/User.pm
diff --git a/lib/RT/User.pm b/lib/RT/User.pm
index fdfd83b..d7115e4 100644
--- a/lib/RT/User.pm
+++ b/lib/RT/User.pm
@@ -289,10 +289,10 @@ sub ValidatePassword {
=head2 SetPrivileged BOOL
-If passed a true value, makes this user a member of the "Privileged" PseudoGroup.
-Otherwise, makes this user a member of the "Unprivileged" pseudogroup.
+If passed a true value, makes this user a member of the "Privileged" group.
+Otherwise, makes this user a member of the "Unprivileged" group.
-Returns a standard RT tuple of (val, msg);
+Returns a standard RT tuple of (value, message);
=cut
@@ -599,17 +599,27 @@ user preferences.
=over 4
-=item 'no email' - user has no email, so can not recieve notifications.
+=item 'no email'
-=item 'squelched' - returned only when Ticket argument is provided and
-notifications to the user has been supressed for this ticket.
+user has no email, so can not receive notifications.
-=item 'daily' - retruned when user recieve daily messages digest instead
-of immediate delivery.
+=item 'squelched'
-=item 'weekly' - previous, but weekly.
+returned only when Ticket argument is provided and notifications to the user
+has been suppressed for this ticket.
-=item empty string returned otherwise.
+=item 'daily'
+
+returned when user receives daily messages digest instead of immediate
+delivery.
+
+=item 'weekly'
+
+same as the previous, but weekly.
+
+=item otherwise
+
+the empty string is returned otherwise.
=back
@@ -658,12 +668,13 @@ sub CanonicalizeEmailAddress {
=head2 CanonicalizeUserInfo HASH of ARGS
-CanonicalizeUserInfo can convert all User->Create options.
-it takes a hashref of all the params sent to User->Create and
-returns that same hash, by default nothing is done.
+CanonicalizeUserInfo can convert all L</Create> options.
+It takes a hashref of all the parameters sent to L</Create> and
+returns success or failure.
-This function is intended to allow users to have their info looked up via
-an outside source and modified upon creation.
+By default the hashref of arguments is not modified at all. This function is
+intended to allow users to have their info looked up via an outside source and
+modified upon creation.
=cut
@@ -714,7 +725,7 @@ sub SetRandomPassword {
=head3 ResetPassword
Returns status, [ERROR or new password]. Resets this user's password to
-a randomly generated pronouncable password and emails them, using a
+a randomly generated pronounceable password and emails them, using a
global template called "RT_PasswordChange", which can be overridden
with global templates "RT_PasswordChange_Privileged" or "RT_PasswordChange_NonPrivileged"
for privileged and Non-privileged users respectively.
@@ -971,10 +982,9 @@ sub CurrentUserRequireToSetPassword {
=head3 AuthToken
-Returns an authentication string associated with the user. This
-string can be used to generate passwordless URLs to integrate
-RT with services and programms like callendar managers, rss
-readers and other.
+Returns an authentication string associated with the user. This string can be
+used to generate password-less URLs to integrate RT with services and programs
+like calendar applications, RSS readers, and so on.
=cut
@@ -1026,8 +1036,9 @@ sub GenerateAuthString {
=head3 ValidateAuthString
-Takes auth string and protected string. Returns true is protected string
-has been protected by user's L</AuthToken>. See also L</GenerateAuthString>.
+Takes an authentication string and protected string. Returns true is protected
+string has been protected by user's L</AuthToken>. See also
+L</GenerateAuthString>.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 189c5ec..5ba4239 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -104,6 +104,7 @@ subcomponents
unary
UTF-8
reparenting
+RSS
# RT JARGON
ACEs
-----------------------------------------------------------------------
More information about the Rt-commit
mailing list