[Rt-commit] rt branch, 4.0/pod-spell, updated. rt-4.0.0rc6-153-g3592962

Shawn Moore sartak at bestpractical.com
Thu Mar 17 19:18:19 EDT 2011


The branch, 4.0/pod-spell has been updated
       via  35929627949509ea2b1a721add4f30317e3d4582 (commit)
       via  22a63b0b881811e7ab192a46416ce05fb5d99cfb (commit)
       via  a8fd9f6e6429623d1d6addbde7689212fd0f0a7f (commit)
       via  b7f4c912388131c664a3c08cb6ac0a65f14fe541 (commit)
       via  ff47fead6c776bd6fd8529122c596dbd6b65cd4b (commit)
       via  d4df1774b73dfd09bd77fe0d62ed5388d93ca9f5 (commit)
       via  0cae7df9ba59a83a55cfe24947d21a0e7c9cda16 (commit)
      from  f597ef51bc9e9a2c49c8cbf89cf98b5e3561488e (commit)

Summary of changes:
 lib/RT/EmailParser.pm |   26 ++++++++++++++----------
 lib/RT/Group.pm       |   24 +++++++++++-----------
 lib/RT/GroupMember.pm |    2 +-
 lib/RT/Handle.pm      |   36 +++++++++++++++++++++++-----------
 lib/RT/I18N.pm        |   51 ++++++++++++++++++++++++++++--------------------
 lib/RT/Installer.pm   |    2 +-
 lib/RT/Lifecycle.pm   |    6 ++--
 t/99-pod-spelling.t   |    4 +++
 8 files changed, 90 insertions(+), 61 deletions(-)

- Log -----------------------------------------------------------------
commit 0cae7df9ba59a83a55cfe24947d21a0e7c9cda16
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 18:33:55 2011 -0400

    Spellcheck lib/RT/EmailParser.pm

diff --git a/lib/RT/EmailParser.pm b/lib/RT/EmailParser.pm
index 7f25d78..439666c 100644
--- a/lib/RT/EmailParser.pm
+++ b/lib/RT/EmailParser.pm
@@ -264,7 +264,7 @@ sub _DecodeBody {
 
 =head2 _PostProcessNewEntity
 
-cleans up and postprocesses a newly parsed MIME Entity
+Cleans up and post-processes a newly parsed L<MIME::Entity> object.
 
 =cut
 
@@ -515,18 +515,22 @@ sub _SetupMIMEParser {
 
 =head2 ParseEmailAddress string
 
-Returns a list of Email::Address objects
-Works around the bug that Email::Address 1.889 and earlier
-doesn't handle local-only email addresses (when users pass
-in just usernames on the RT system in fields that expect
-Email Addresses)
+Returns a list of L<Email::Address> objects.
+
+This method works around a bug that L<Email::Address> 1.889 and earlier have
+which causes it to not handle local-only email addresses (when users pass in
+just usernames on the RT system in fields that expect Email Addresses)
+
+We don't handle the case of
+
+    bob, fred at bestpractical.com
 
-We don't handle the case of 
-bob, fred at bestpractical.com 
 because we don't want to fail parsing
-bob, "Falcone, Fred" <fred at bestpractical.com>
-The next release of Email::Address will have a new method
-we can use that removes the bandaid
+
+    bob, "Falcone, Fred" <fred at bestpractical.com>
+
+The next release of L<Email::Address> will have a new method
+we can use that removes this band-aid.
 
 =cut
 
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 0744e90..144836c 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -88,6 +88,7 @@ overridable
 variable's
 iCalendar
 textbox
+usernames
 
 # RT JARGON
 ACEs

commit d4df1774b73dfd09bd77fe0d62ed5388d93ca9f5
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 19:03:30 2011 -0400

    Spellcheck lib/RT/Group.pm

diff --git a/lib/RT/Group.pm b/lib/RT/Group.pm
index e048f48..3b9668b 100644
--- a/lib/RT/Group.pm
+++ b/lib/RT/Group.pm
@@ -269,12 +269,12 @@ sub LoadUserDefinedGroup {
 
 =head2 LoadACLEquivalenceGroup PRINCIPAL
 
-Loads a user's acl equivalence group. Takes a principal object or its ID.
-ACL equivalnce groups are used to simplify the acl system. Each user
+Loads a user's ACL equivalence group. Takes a principal object or its ID.
+ACL equivalence groups are used to simplify the ACL system. Each user
 has one group that only he is a member of. Rights granted to the user
 are actually granted to that group. This greatly simplifies ACL checks.
 While this results in a somewhat more complex setup when creating users
-and granting ACLs, it _greatly_ simplifies acl checks.
+and granting ACLs, it _greatly_ simplifies ACL checks.
 
 =cut
 
@@ -317,7 +317,7 @@ sub LoadSystemInternalGroup {
 
 Loads a ticket group from the database. 
 
-Takes a param hash with 2 parameters:
+Takes a paramhash with two parameters:
 
     Ticket is the TicketId we're curious about
     Type is the type of Group we're trying to load: 
@@ -342,7 +342,7 @@ sub LoadTicketRoleGroup {
 
 Loads a Queue group from the database. 
 
-Takes a param hash with 2 parameters:
+Takes a paramhash with two parameters:
 
     Queue is the QueueId we're curious about
     Type is the type of Group we're trying to load: 
@@ -367,7 +367,7 @@ sub LoadQueueRoleGroup {
 
 Loads a System group from the database. 
 
-Takes a single param: Type
+Takes a single parameter: Type
 
     Type is the type of Group we're trying to load: 
         Requestor, Cc, AdminCc, Owner
@@ -535,9 +535,9 @@ sub _ValidateUserDefinedName {
 
 A helper subroutine which creates a group containing only 
 an individual user. This gets used by the ACL system to check rights.
-Yes, it denormalizes the data, but that's ok, as we totally win on performance.
+Yes, it denormalizes the data, but that's okay, as we totally win on performance.
 
-Returns a tuple of (Id, Message).  If id is 0, the create failed
+Returns a tuple of (Id, Message). If ID is 0, the create failed.
 
 =cut
 
@@ -861,7 +861,7 @@ sub MemberEmailAddressesAsString {
 
 AddMember adds a principal to this group.  It takes a single principal id.
 Returns a two value array. the first value is true on successful 
-addition or 0 on failure.  The second value is a textual status msg.
+addition or 0 on failure.  The second value is a textual status message.
 
 =cut
 
@@ -1033,10 +1033,10 @@ sub HasMemberRecursively {
 =head2 DeleteMember PRINCIPAL_ID
 
 Takes the principal id of a current user or group.
-If the current user has apropriate rights,
-removes that GroupMember from this group.
+If the current user has appropriate rights,
+removes that L<RT::GroupMember> from this group.
 Returns a two value array. the first value is true on successful 
-addition or 0 on failure.  The second value is a textual status msg.
+addition or 0 on failure.  The second value is a textual status message.
 
 =cut
 
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 144836c..778d400 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -89,6 +89,7 @@ variable's
 iCalendar
 textbox
 usernames
+denormalizes
 
 # RT JARGON
 ACEs

commit ff47fead6c776bd6fd8529122c596dbd6b65cd4b
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 19:03:37 2011 -0400

    Spellcheck lib/RT/GroupMember.pm

diff --git a/lib/RT/GroupMember.pm b/lib/RT/GroupMember.pm
index 84887ee..2f7335b 100644
--- a/lib/RT/GroupMember.pm
+++ b/lib/RT/GroupMember.pm
@@ -224,7 +224,7 @@ sub Create {
 
 Create { Group => undef, Member => undef }
 
-Creates an entry in the groupmembers table, which lists a user
+Creates an entry in the C<groupmembers> table, which lists a user
 as a member of himself. This makes ACL checks a whole bunch easier.
 This happens once on user create and never ever gets yanked out.
 

commit b7f4c912388131c664a3c08cb6ac0a65f14fe541
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 19:10:13 2011 -0400

    Spellcheck lib/RT/Handle.pm

diff --git a/lib/RT/Handle.pm b/lib/RT/Handle.pm
index 6aff7fe..767a9da 100644
--- a/lib/RT/Handle.pm
+++ b/lib/RT/Handle.pm
@@ -58,11 +58,11 @@ RT::Handle - RT's database handle
 
 =head1 DESCRIPTION
 
-C<RT::Handle> is RT specific wrapper over one of L<DBIx::SearchBuilder::Handle>
-classes. As RT works with different types of DBs we subclass repsective handler
-from L<DBIx::SerachBuilder>. Type of the DB is defined by C<DatabasseType> RT's
-config option. You B<must> load this module only when the configs have been
-loaded.
+C<RT::Handle> is an RT-specific wrapper for one of the
+L<DBIx::SearchBuilder::Handle> subclasses. Since RT works with different
+database engines, we subclass the database handler class of L<DBIx::SearchBuilder>
+chosen by RT's C<DatabaseType> config option. You B<must> load this module only
+after the configuration has been fully loaded.
 
 =cut
 
@@ -292,7 +292,7 @@ sub CheckCompatibility {
     return (1)
 }
 
-=head2 Database maintanance
+=head2 Database maintenance
 
 =head3 CreateDatabase $DBH
 
@@ -1046,7 +1046,7 @@ sub InsertData {
 
 =head2 ACLEquivGroupId
 
-Given a userid, return that user's acl equivalence group
+Given a user ID, return that user's ACL equivalence group.
 
 =cut
 
@@ -1069,8 +1069,9 @@ sub ACLEquivGroupId {
 =head2 QueryHistory
 
 Returns the SQL query history associated with this handle. The top level array
-represents a lists of request. Each request is a hash with metadata about the
-request (such as the URL) and a list of queries. You'll probably not be using this.
+represents a list of request. Each request is a hash with metadata about the
+request (such as the C<Path>) and a list of C<Queries>. You'll probably not be
+using this.
 
 =cut
 
@@ -1082,9 +1083,20 @@ sub QueryHistory {
 
 =head2 AddRequestToHistory
 
-Adds a web request to the query history. It must be a hash with keys Path (a
-string) and Queries (an array reference of arrays, where elements are time,
-sql, bind parameters, and duration).
+Adds a web request to the query history. It must be a hash with the following keys:
+
+=over 4
+
+=item C<Path>
+
+A string representing the web path which caused this SQL query.
+
+=item C<Queries>
+
+An array reference of arrays, where elements are time, the SQL query as a
+string, bind parameters, and duration.
+
+=back
 
 =cut
 

commit a8fd9f6e6429623d1d6addbde7689212fd0f0a7f
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 19:16:45 2011 -0400

    Spellcheck lib/RT/I18N.pm

diff --git a/lib/RT/I18N.pm b/lib/RT/I18N.pm
index a1f2af5..ffbd6f7 100644
--- a/lib/RT/I18N.pm
+++ b/lib/RT/I18N.pm
@@ -162,8 +162,8 @@ sub encoding { 'utf-8' }
 
 =head2 SetMIMEEntityToUTF8 $entity
 
-An utility function which will try to convert entity body into utf8.
-It's now a wrap-up of SetMIMEEntityToEncoding($entity, 'utf-8').
+A utility function which will try to convert entity body into C<utf8>.
+It's now a wrapper for C<SetMIMEEntityToEncoding($entity, 'utf-8')>.
 
 =cut
 
@@ -175,10 +175,10 @@ sub SetMIMEEntityToUTF8 {
 
 =head2 IsTextualContentType $type
 
-An utility function that determines whether $type is I<textual>, meaning
+An utility function that determines whether C<$type> is I<textual>, meaning
 that it can sensibly be converted to Unicode text.
 
-Currently, it returns true iff $type matches this regular expression
+Currently, it returns true if and only if C<$type> matches this regular expression
 (case-insensitively):
 
     ^(?:text/(?:plain|html)|message/rfc822)\b
@@ -194,15 +194,22 @@ sub IsTextualContentType {
 
 =head2 SetMIMEEntityToEncoding $entity, $encoding
 
-An utility function which will try to convert entity body into specified
-charset encoding (encoded as octets, *not* unicode-strings).  It will
-iterate all the entities in $entity, and try to convert each one into
-specified charset if whose Content-Type is 'text/plain'.
+A utility function which will try to convert the entity body into the specified
+charset encoding (encoded as octets, *not* unicode-strings). It will
+iterate over all the entities in C<$entity>, and try to convert each one into
+specified charset if the entity's C<Content-Type> is 'text/plain'.
 
-the methods are tries in order:
-1) to convert the entity to $encoding, 
-2) to interpret the entity as iso-8859-1 and then convert it to $encoding,
-3) forcibly convert it to $encoding.
+These methods are tried in order:
+
+=over 4
+
+=item convert the entity to C<$encoding>
+
+=item interpret the entity as C<iso-8859-1> and then convert it to C<$encoding>
+
+=item forcibly convert it to C<$encoding>
+
+=back
 
 This function doesn't return anything meaningful.
 
@@ -302,14 +309,14 @@ sub SetMIMEEntityToEncoding {
 =head2 DecodeMIMEWordsToUTF8 $raw
 
 An utility method which mimics MIME::Words::decode_mimewords, but only
-limited functionality.  This function returns an utf-8 string.
+limited functionality.  This function returns a C<utf-8> string.
 
-It returns the decoded string, or the original string if it's not
-encoded.  Since the subroutine converts specified string into utf-8
-charset, it should not alter a subject written in English.
+It returns the decoded string, or the original string if it's not encoded.
+Since the subroutine converts the specified string into the C<utf-8> charset,
+it should not alter a subject written in English.
 
-Why not use MIME::Words directly?  Because it fails in RT when I
-tried.  Maybe it's ok now.
+TODO: Why not use L<MIME::Words> directly?  Because it fails in RT when I
+tried. Maybe it's okay now.
 
 =cut
 
@@ -538,8 +545,10 @@ sub _GuessCharset {
 
 =head2 _CanonicalizeCharset NAME
 
-canonicalize charset, return lowercase version.
-special cases are: gb2312 => gbk, utf8 => utf-8
+This canonicalizes the provided charset, returning the lowercase version.
+
+Special cases are: C<gb2312> becomes C<gbk>, C<utf8> and C<utf-8-strict> become
+C<utf-8>.
 
 =cut
 
@@ -564,7 +573,7 @@ sub _CanonicalizeCharset {
 
 Converts a MIME Head from one encoding to another. This totally violates the RFC.
 We should never need this. But, Surprise!, MUAs are badly broken and do this kind of stuff
-all the time
+all the time.
 
 
 =cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 778d400..709babf 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -37,6 +37,7 @@ DSN
 GPG
 GnuPG
 MUA
+MUAs
 SQL
 STDERR
 STDOUT
@@ -90,6 +91,7 @@ iCalendar
 textbox
 usernames
 denormalizes
+canonicalizes
 
 # RT JARGON
 ACEs

commit 22a63b0b881811e7ab192a46416ce05fb5d99cfb
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 19:17:12 2011 -0400

    Spellcheck lib/RT/Installer.pm

diff --git a/lib/RT/Installer.pm b/lib/RT/Installer.pm
index a1e9ea0..7a95ff3 100644
--- a/lib/RT/Installer.pm
+++ b/lib/RT/Installer.pm
@@ -301,7 +301,7 @@ sub SaveConfig {
 
     RT::Installer - RT's Installer
 
-=head1 SYNOPSYS
+=head1 SYNOPSIS
 
     use RT::Installer;
     my $meta = RT::Installer->Meta;

commit 35929627949509ea2b1a721add4f30317e3d4582
Author: Shawn M Moore <sartak at bestpractical.com>
Date:   Thu Mar 17 19:18:15 2011 -0400

    Spellcheck lib/RT/Lifecycle.pm

diff --git a/lib/RT/Lifecycle.pm b/lib/RT/Lifecycle.pm
index a21042d..5f18e70 100644
--- a/lib/RT/Lifecycle.pm
+++ b/lib/RT/Lifecycle.pm
@@ -160,7 +160,7 @@ sub List {
 
 =head2 Name
 
-Returns name of the laoded lifecycle.
+Returns name of the loaded lifecycle.
 
 =cut
 
@@ -376,7 +376,7 @@ Takes status and returns list of statuses it can be changed to.
 Is status is empty or undefined then returns list of statuses for
 a new ticket.
 
-If argument is ommitted then returns a hash with all possible
+If the argument is omitted, then this returns a hash with all possible
 transitions in the following format:
 
     status_x => [ next_status, next_status, ... ],
@@ -432,7 +432,7 @@ sub CheckRight {
 
 =head3 RegisterRights
 
-Registers all defined rights in the system, so they can be addigned
+Registers all defined rights in the system, so they can be assigned
 to users. No need to call it, as it's called when module is loaded.
 
 =cut

-----------------------------------------------------------------------


More information about the Rt-commit mailing list