[Rt-commit] rt branch, 4.0/pod-spell, updated. rt-4.0.0rc6-189-g42baa3b
Shawn Moore
sartak at bestpractical.com
Thu Mar 17 22:02:30 EDT 2011
The branch, 4.0/pod-spell has been updated
via 42baa3b8d748b61b2bc7c5e3f380f38afb9d2986 (commit)
via f94997031ae850c71a1c619694019a84518b514a (commit)
via 8a908f4b43c8a8dca405dd2839642a6171daac14 (commit)
via ccb60968142b4bd385e20f32514ce42a5a4610cd (commit)
via 6bf6bc5b59ded8713d8fcdfeb19c989fc393c0be (commit)
via 6ddf131160d574913fd63f785be2e427bcb95023 (commit)
from 1b490950dfea71044c55a12be5343540feebaf25 (commit)
Summary of changes:
lib/RT/Interface/Email/Auth/GnuPG.pm | 6 +++---
lib/RT/Interface/Web/Handler.pm | 2 +-
lib/RT/Interface/Web/QueryBuilder/Tree.pm | 4 ++--
lib/RT/Interface/Web/Request.pm | 2 +-
lib/RT/Interface/Web/Session.pm | 2 +-
lib/RT/Shredder/Plugin/Base.pm | 20 ++++++++++----------
lib/RT/Shredder/Plugin/Base/Search.pm | 13 +++++++------
lib/RT/Shredder/Plugin/Objects.pm | 7 +++----
lib/RT/Shredder/Plugin/Tickets.pm | 2 +-
lib/RT/URI/fsck_com_article.pm | 4 ++--
lib/RT/URI/fsck_com_rt.pm | 4 ++--
lib/RT/URI/t.pm | 4 ++--
12 files changed, 35 insertions(+), 35 deletions(-)
- Log -----------------------------------------------------------------
commit 6ddf131160d574913fd63f785be2e427bcb95023
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 21:55:08 2011 -0400
Spellcheck the rest of lib/RT/URI/*
diff --git a/lib/RT/URI/fsck_com_article.pm b/lib/RT/URI/fsck_com_article.pm
index f651d2e..a1627aa 100644
--- a/lib/RT/URI/fsck_com_article.pm
+++ b/lib/RT/URI/fsck_com_article.pm
@@ -91,7 +91,7 @@ When handed an L<RT::Article> object, figure out its URI
=head2 ParseURI URI
-When handed an fsck.com-article URI, figures out things like whether its a local article
+When handed an C<fsck.com-article> URI, figures out things like whether its a local article
and what its ID is
=cut
@@ -180,7 +180,7 @@ sub Scheme {
=head2 HREF
-If this is a local article, return an HTTP url to it.
+If this is a local article, return an HTTP URL to it.
Otherwise, return its URI
=cut
diff --git a/lib/RT/URI/fsck_com_rt.pm b/lib/RT/URI/fsck_com_rt.pm
index aa0b4e0..7760ac6 100644
--- a/lib/RT/URI/fsck_com_rt.pm
+++ b/lib/RT/URI/fsck_com_rt.pm
@@ -98,7 +98,7 @@ sub URIForObject {
=head2 ParseURI URI
-When handed an fsck.com-rt: URI, figures out things like whether its a local record and what its ID is
+When handed an C<fsck.com-rt:> URI, figures out things like whether its a local record and what its ID is
=cut
@@ -189,7 +189,7 @@ sub Scheme {
=head2 HREF
-If this is a local ticket, return an HTTP url to it.
+If this is a local ticket, return an HTTP URL to it.
Otherwise, return its URI
=cut
diff --git a/lib/RT/URI/t.pm b/lib/RT/URI/t.pm
index bce178a..f13b66b 100644
--- a/lib/RT/URI/t.pm
+++ b/lib/RT/URI/t.pm
@@ -78,11 +78,11 @@ use base 'RT::URI::fsck_com_rt';
=head1 NAME
-RT::URI::t - aliad for RT::URI::fsck_com_rt that supports 't:12345' URIs
+RT::URI::t - alias for RT::URI::fsck_com_rt that supports 't:12345' URIs
=head2 ParseURI URI
-When handed an t: URI, figures out if it is an RT ticket. This is an
+When handed a C<t:> URI, figures out if it is an RT ticket. This is an
alternate short form of specifying a full ticket URI.
=cut
commit 6bf6bc5b59ded8713d8fcdfeb19c989fc393c0be
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 21:56:13 2011 -0400
Spellcheck lib/RT/Interface/Web/*
diff --git a/lib/RT/Interface/Web/Handler.pm b/lib/RT/Interface/Web/Handler.pm
index 73f0b9e..d50c6b9 100644
--- a/lib/RT/Interface/Web/Handler.pm
+++ b/lib/RT/Interface/Web/Handler.pm
@@ -156,7 +156,7 @@ and is not recommended to change.
=item Clean up state of RT::Action::SendEmail using 'CleanSlate' method
-=item Flush tmp GnuPG key preferences
+=item Flush temporary GnuPG key preferences
=back
diff --git a/lib/RT/Interface/Web/Request.pm b/lib/RT/Interface/Web/Request.pm
index f08228b..ac8acf1 100644
--- a/lib/RT/Interface/Web/Request.pm
+++ b/lib/RT/Interface/Web/Request.pm
@@ -69,7 +69,7 @@ Method replaces deprecated component C<Element/Callback>.
Takes hash with optional C<CallbackPage>, C<CallbackName>
and C<CallbackOnce> arguments, other arguments are passed
-throught to callback components.
+through to callback components.
=over 4
diff --git a/lib/RT/Interface/Web/Session.pm b/lib/RT/Interface/Web/Session.pm
index 0cce092..abc3949 100644
--- a/lib/RT/Interface/Web/Session.pm
+++ b/lib/RT/Interface/Web/Session.pm
@@ -56,7 +56,7 @@ use RT::CurrentUser;
RT::Interface::Web::Session - RT web session class
-=head1 SYNOPSYS
+=head1 SYNOPSIS
=head1 DESCRIPTION
commit ccb60968142b4bd385e20f32514ce42a5a4610cd
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 21:59:00 2011 -0400
Spellcheck lib/RT/Shredder/Plugin/*
diff --git a/lib/RT/Shredder/Plugin/Base.pm b/lib/RT/Shredder/Plugin/Base.pm
index d95279e..2a3e8cd 100644
--- a/lib/RT/Shredder/Plugin/Base.pm
+++ b/lib/RT/Shredder/Plugin/Base.pm
@@ -131,13 +131,13 @@ sub HasSupportForArgs
=head3 TestArgs
-Takes hash with arguments and thier values and returns true
+Takes a hash with arguments and their values and returns true
if all values pass testing otherwise returns C<(0, $msg)>.
-Stores arguments hash in C<$self->{'opt'}>, you can access this hash
-from C<Run> method.
+Stores arguments hash in C<< $self->{'opt'} >>, you can access this hash
+in the L</Run> method.
-Method should be subclassed if plugin support non standard arguments.
+Method should be subclassed if plugin supports non-standard arguments.
=cut
@@ -156,19 +156,19 @@ sub TestArgs
=head3 Run
Takes no arguments.
-Executes plugin and return C<(1, @objs)> on success or
-C<(0, $msg)> if error had happenned.
+Executes plugin and returns C<(1, @objs)> on success or
+C<(0, $msg)> on error.
-Method B<must> be subclassed, this class always returns error.
+Method B<must> be subclassed, so this class always returns an error.
-Method B<must> be called only after C<TestArgs> method in other
-case values of the arguments are not available.
+Method B<must> be called only after C<TestArgs> method, otherwise
+the values of the arguments are not available.
=cut
sub Run { return (0, "This is abstract plugin, you couldn't use it directly") }
-=head2 utils
+=head2 utility methods
=head3 ConvertMaskToSQL
diff --git a/lib/RT/Shredder/Plugin/Objects.pm b/lib/RT/Shredder/Plugin/Objects.pm
index 963b3d5..4759595 100644
--- a/lib/RT/Shredder/Plugin/Objects.pm
+++ b/lib/RT/Shredder/Plugin/Objects.pm
@@ -60,10 +60,9 @@ RT::Shredder::Plugin::Objects - search plugin for wiping any selected object.
=head1 ARGUMENTS
-This plugin searches an RT object you want, so you can use
-the object name as argument and id as value, for example if
-you want select ticket #123 then from CLI you write next
-command:
+This plugin searches for the RT object you want, so you can use
+the object name as the argument and id as the value. For example if
+you want to select ticket #123, you can write:
rt-shredder --plugin 'Objects=Ticket,123'
diff --git a/lib/RT/Shredder/Plugin/Tickets.pm b/lib/RT/Shredder/Plugin/Tickets.pm
index 156f8ff..dfe509f 100644
--- a/lib/RT/Shredder/Plugin/Tickets.pm
+++ b/lib/RT/Shredder/Plugin/Tickets.pm
@@ -72,7 +72,7 @@ Arguments C<queue>, C<status> and C<updated_before> have been dropped
as you can easy make the same search with the C<query> option.
See examples above.
-=head2 with_linked - boolen
+=head2 with_linked - boolean
Deletes all tickets that are linked to tickets that match L<query>.
commit 8a908f4b43c8a8dca405dd2839642a6171daac14
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 21:59:44 2011 -0400
Spellcheck lib/RT/Interface/Email/Auth/GnuPG.pm
diff --git a/lib/RT/Interface/Email/Auth/GnuPG.pm b/lib/RT/Interface/Email/Auth/GnuPG.pm
index 25b8f10..542e01c 100644
--- a/lib/RT/Interface/Email/Auth/GnuPG.pm
+++ b/lib/RT/Interface/Email/Auth/GnuPG.pm
@@ -53,10 +53,10 @@ use warnings;
=head2 GetCurrentUser
-To use the gnupg-secured mail gateway, you need to do the following:
+To use the GnuPG-secured mail gateway, you need to do the following:
-Set up a GnuPG key directory with a pubring containing only the keys
-you care about and specify the following in your SiteConfig.pm
+Set up a GnuPG key directory with a public keyring containing only the keys
+you care about and specify the following in your F<RT_SiteConfig.pm>:
Set(%GnuPGOptions, homedir => '/opt/rt4/var/data/GnuPG');
Set(@MailPlugins, 'Auth::MailFrom', 'Auth::GnuPG', ...other filter...);
commit f94997031ae850c71a1c619694019a84518b514a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 22:00:50 2011 -0400
Spellcheck lib/RT/Interface/Web/QueryBuilder/Tree.pm
diff --git a/lib/RT/Interface/Web/QueryBuilder/Tree.pm b/lib/RT/Interface/Web/QueryBuilder/Tree.pm
index 493ab44..719e590 100644
--- a/lib/RT/Interface/Web/QueryBuilder/Tree.pm
+++ b/lib/RT/Interface/Web/QueryBuilder/Tree.pm
@@ -149,8 +149,8 @@ sub GetQueryAndOptionList {
=head2 PruneChildLessAggregators
-If tree manipulation has left it in a state where there are ANDs, ORs,
-or parenthesizations with no children, get rid of them.
+If tree manipulation has left it in a state where there are C<AND>s, C<OR>s,
+or parenthesized groups with no children, prune them.
=cut
commit 42baa3b8d748b61b2bc7c5e3f380f38afb9d2986
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 22:02:19 2011 -0400
Spellcheck lib/RT/Shredder/Plugin/Base/Search.pm
diff --git a/lib/RT/Shredder/Plugin/Base/Search.pm b/lib/RT/Shredder/Plugin/Base/Search.pm
index 1c20b4f..70f7fa2 100644
--- a/lib/RT/Shredder/Plugin/Base/Search.pm
+++ b/lib/RT/Shredder/Plugin/Base/Search.pm
@@ -104,15 +104,16 @@ sub SetResolvers { return 1 }
=head2 FetchNext $collection [, $init]
-Returns next object in collection as method L<RT::SearchBuilder/Next>, but
+Returns the next object in the collection, like L<RT::SearchBuilder/Next>, but
doesn't stop on page boundaries.
-When method is called with true C<$init> arg it enables pages on collection
-and selects first page.
+When the method is called with a true C<$init> argument, it enables pages on
+the collection and selects the first page.
-Main purpose of this method is to avoid loading of whole collection into
-memory as RT does by default when pager is not used. This method init paging
-on the collection, but doesn't stop when reach page end.
+The main purpose of this method is to avoid loading of whole collection into
+memory, which RT does by default when the pager is not used. This method
+initializes paging on the collection, but doesn't stop when reaching the end of
+a page.
Example:
-----------------------------------------------------------------------
More information about the Rt-commit
mailing list