[Rt-commit] rt branch, 4.0/pod-spell, updated. rt-4.0.0rc6-139-g2b5a989
Shawn Moore
sartak at bestpractical.com
Thu Mar 17 17:41:49 EDT 2011
The branch, 4.0/pod-spell has been updated
via 2b5a98990b72542381dc140f0792d69260bfd64d (commit)
via 9c10b0b2d6d486ddb2b9b2b9de247cc7d58308d0 (commit)
via 4e1c6e96902d3347358217861aa20410524331da (commit)
via d2319984a34f9ed7ebf548ee4d8a2030e4f1be42 (commit)
via a9b12afa5b903d5f49e4c65ba0bc722ad02f251e (commit)
via 0ef94cad7b7c3b6441640be0eeac6fae4b09532a (commit)
via 852350c6fa4cf7f3093d04680c7d0fc45c98eb72 (commit)
via 9f1716cbd104d2b3302acbefcb3b6091e9443af3 (commit)
via e6631666d013168577828e0b0e2fbd6fc02343e8 (commit)
from ac7de8026f8fbec1cf17f1859e7b20548a3072f1 (commit)
Summary of changes:
lib/RT/ACE.pm | 19 ++++++++++---------
lib/RT/Article.pm | 12 ++++++------
lib/RT/Articles.pm | 7 ++++---
lib/RT/Attachment.pm | 6 +++---
lib/RT/Attachments.pm | 6 +++---
lib/RT/Attribute.pm | 3 ++-
lib/RT/Base.pm | 10 +++++-----
lib/RT/CachedGroupMember.pm | 13 ++++++-------
lib/RT/CachedGroupMembers.pm | 6 +++---
t/99-pod-spelling.t | 11 +++++++++++
10 files changed, 53 insertions(+), 40 deletions(-)
- Log -----------------------------------------------------------------
commit e6631666d013168577828e0b0e2fbd6fc02343e8
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:26:05 2011 -0400
Spellcheck lib/RT/ACE.pm
diff --git a/lib/RT/ACE.pm b/lib/RT/ACE.pm
index f8677ce..0bd95b6 100644
--- a/lib/RT/ACE.pm
+++ b/lib/RT/ACE.pm
@@ -176,9 +176,9 @@ sub LoadByValues {
-=head2 Create <PARAMS>
+=head2 Create C<PARAMS>
-PARAMS is a parameter hash with the following elements:
+C<PARAMS> is a parameter hash with the following elements:
PrincipalId => The id of an RT::Principal object
PrincipalType => "User" "Group" or any Role type
@@ -310,9 +310,10 @@ sub Create {
=head2 Delete { InsideTransaction => undef}
-Delete this object. This method should ONLY ever be called from RT::User or RT::Group (or from itself)
-If this is being called from within a transaction, specify a true value for the parameter InsideTransaction.
-Really, DBIx::SearchBuilder should use and/or fake subtransactions
+Delete this object. This method should ONLY ever be called from L<RT::User> or
+L<RT::Group> (or from itself). If this is being called from within a
+transaction, specify a true value for the parameter C<InsideTransaction>. Really,
+L<DBIx::SearchBuilder> should use and/or fake sub-transactions.
=cut
@@ -357,12 +358,12 @@ sub _Delete {
=head2 _BootstrapCreate
-Grant a right with no error checking and no ACL. this is _only_ for
+Grants a right with no error checking and no ACL. This is _only_ for
installation. If you use this routine without the author's explicit
written approval, he will hunt you down and make you spend eternity
-translating mozilla's code into FORTRAN or intercal.
+translating Mozilla's code into FORTRAN or Intercal.
-If you think you need this routine, you've mistaken.
+If you think you need this routine, you're mistaken.
=cut
@@ -514,7 +515,7 @@ sub _Value {
Takes a principal id and a principal type.
-If the principal is a user, resolves it to the proper acl equivalence group.
+If the principal is a user, resolves it to the proper ACL equivalence group.
Returns a tuple of (RT::Principal, PrincipalType) for the principal we really want to work with
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index a737b5d..b8472d7 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -77,6 +77,8 @@ unix
username
workflow
hostname
+Mozilla's
+Intercal
# RT JARGON
ACEs
commit 9f1716cbd104d2b3302acbefcb3b6091e9443af3
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:28:43 2011 -0400
Spellcheck lib/RT/Article.pm
diff --git a/lib/RT/Article.pm b/lib/RT/Article.pm
index fe3e391..105eb19 100644
--- a/lib/RT/Article.pm
+++ b/lib/RT/Article.pm
@@ -352,8 +352,8 @@ sub Children {
=head2 AddLink
-Takes a paramhash of Type and one of Base or Target. Adds that link to this tick
-et.
+Takes a paramhash of C<Type> and one of C<Base> or C<Target>. Adds that link to
+this ticket.
=cut
@@ -577,9 +577,9 @@ sub _Set {
}
-=head2 _Value PARAM
+=head2 _Value C<PARAM>
-Return "PARAM" for this object. if the current user doesn't have rights, returns undef
+Return C<PARAM> for this object. If the current user doesn't have rights, returns C<undef>.
=cut
@@ -615,9 +615,9 @@ Takes the name of a form field from "Include Article"
and the value submitted by the browser and attempts to load an Article.
This handles Articles included by searching, by the Name and via
-the hotlist.
+the HotList.
-If you optionaly pass an id as the Queue argument, this will check that
+If you optionally pass an id as the Queue argument, this will verify that
the Article's Class is applied to that Queue.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index b8472d7..8eb280c 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -102,3 +102,4 @@ crontool
lifecycle
lifecycles
mailgate
+HotList
commit 852350c6fa4cf7f3093d04680c7d0fc45c98eb72
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:30:57 2011 -0400
Spellcheck lib/RT/Articles.pm
diff --git a/lib/RT/Articles.pm b/lib/RT/Articles.pm
index 355a2bd..687cb03 100644
--- a/lib/RT/Articles.pm
+++ b/lib/RT/Articles.pm
@@ -235,10 +235,11 @@ Limit the result set to articles which have or do not have the custom field
value listed, using a left join to catch things where no rows match.
HASH needs the following fields:
+
FIELD (A custom field id) or undef for any custom field
ENTRYAGGREGATOR => (AND, OR)
OPERATOR ('=', 'LIKE', '!=', 'NOT LIKE')
- VALUE ( a single scalar value or a list of possible values to be concatenated with ENTRYAGGREGATOR)
+ VALUE (a single scalar value or a list of possible values to be concatenated with ENTRYAGGREGATOR)
The subclause that the LIMIT statement(s) should be done in can also
be passed in with a SUBCLAUSE parameter.
@@ -479,9 +480,9 @@ sub LimitReferredToBy {
# }}}
-=head2 LimitHostlistClasses
+=head2 LimitHotlistClasses
-Only fetch Articles from classes where Hotlist is true.
+Only fetch Articles from classes where HotList is true.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 8eb280c..460ca79 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -79,6 +79,7 @@ workflow
hostname
Mozilla's
Intercal
+subclause
# RT JARGON
ACEs
commit 0ef94cad7b7c3b6441640be0eeac6fae4b09532a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:32:22 2011 -0400
Spellcheck lib/RT/Attachment.pm
diff --git a/lib/RT/Attachment.pm b/lib/RT/Attachment.pm
index 7fc9aba..fa6258e 100644
--- a/lib/RT/Attachment.pm
+++ b/lib/RT/Attachment.pm
@@ -223,7 +223,7 @@ sub Import {
=head2 TransactionObj
-Returns the transaction object asscoiated with this attachment.
+Returns the transaction object associated with this attachment.
=cut
@@ -480,7 +480,7 @@ sub Addresses {
=head2 NiceHeaders
-Returns a multi-line string of the To, From, Cc, Date and Subject headers.
+Returns a multiline string of the To, From, Cc, Date and Subject headers.
=cut
@@ -625,7 +625,7 @@ sub SplitHeaders {
=head2 _SplitHeaders
Returns an array of this attachment object's headers, with one header
-per array entry. multiple lines are folded.
+per array entry. Multiple lines are folded.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 460ca79..7778633 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -80,6 +80,7 @@ hostname
Mozilla's
Intercal
subclause
+longtext
# RT JARGON
ACEs
commit a9b12afa5b903d5f49e4c65ba0bc722ad02f251e
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:33:49 2011 -0400
Spellcheck lib/RT/Attachments.pm
diff --git a/lib/RT/Attachments.pm b/lib/RT/Attachments.pm
index c02c458..635ee9e 100644
--- a/lib/RT/Attachments.pm
+++ b/lib/RT/Attachments.pm
@@ -101,9 +101,9 @@ sub CleanSlate {
=head2 TransactionAlias
-Returns alias for transactions table with applied join condition.
-Always return the same alias, so if you want to build some complex
-or recursive joining then you have to create new alias youself.
+Returns the alias for the joined transactions table. This always returns the
+same alias, so if you want to build some complex or recursive joins then you
+must create a new alias yourself.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 7778633..022c79d 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -81,6 +81,7 @@ Mozilla's
Intercal
subclause
longtext
+ENTRYAGGREGATOR
# RT JARGON
ACEs
commit d2319984a34f9ed7ebf548ee4d8a2030e4f1be42
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:35:52 2011 -0400
Spellcheck lib/RT/Attribute.pm
diff --git a/lib/RT/Attribute.pm b/lib/RT/Attribute.pm
index e6eec4f..a839e20 100644
--- a/lib/RT/Attribute.pm
+++ b/lib/RT/Attribute.pm
@@ -433,7 +433,8 @@ sub CurrentUserHasRight {
=head1 TODO
-We should be deserializing the content on load and then enver again, rather than at every access
+We should be deserializing the content on load and then never again, rather
+than at every access.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 022c79d..0b231d8 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -82,6 +82,7 @@ Intercal
subclause
longtext
ENTRYAGGREGATOR
+deserializing
# RT JARGON
ACEs
@@ -106,3 +107,6 @@ lifecycle
lifecycles
mailgate
HotList
+attribute's
+subvalue
+subvalues
commit 4e1c6e96902d3347358217861aa20410524331da
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:37:29 2011 -0400
Spellcheck lib/RT/Base.pm
diff --git a/lib/RT/Base.pm b/lib/RT/Base.pm
index e2de668..94779e9 100644
--- a/lib/RT/Base.pm
+++ b/lib/RT/Base.pm
@@ -117,16 +117,16 @@ sub OriginalUser {
=head2 loc LOC_STRING
-l is a method which takes a loc string
-to this object's CurrentUser->LanguageHandle for localization.
+C<loc> is a method which localizes the given string using this object's
+C<< CurrentUser->LanguageHandle >>.
-you call it like this:
+You call it like this:
$self->loc("I have [quant,_1,concrete mixer].", 6);
-In english, this would return:
- I have 6 concrete mixers.
+In English, this would return:
+ I have 6 concrete mixers.
=cut
commit 9c10b0b2d6d486ddb2b9b2b9de247cc7d58308d0
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:41:32 2011 -0400
Spellcheck lib/RT/CachedGroupMember.pm
diff --git a/lib/RT/CachedGroupMember.pm b/lib/RT/CachedGroupMember.pm
index c6ef008..37eedda 100644
--- a/lib/RT/CachedGroupMember.pm
+++ b/lib/RT/CachedGroupMember.pm
@@ -183,9 +183,9 @@ sub Create {
=head2 Delete
-Deletes the current CachedGroupMember from the group it's in and cascades
-the delete to all submembers. This routine could be completely excised if
-mysql supported foreign keys with cascading deletes.
+Deletes the current CachedGroupMember from the group it's in and cascades the
+delete to all children CachedGroupMember records. This routine could be
+completely excised if MySQL supported foreign keys with cascading deletes.
=cut
@@ -225,11 +225,10 @@ sub Delete {
=head2 SetDisabled
-SetDisableds the current CachedGroupMember from the group it's in and cascades
-the SetDisabled to all submembers. This routine could be completely excised if
-mysql supported foreign keys with cascading SetDisableds.
+Sets the current CachedGroupMember as disabled, recursing over all children
+CachedGroupMember records.
-=cut
+=cut
sub SetDisabled {
my $self = shift;
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 0b231d8..386e704 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -83,6 +83,7 @@ subclause
longtext
ENTRYAGGREGATOR
deserializing
+recursing
# RT JARGON
ACEs
commit 2b5a98990b72542381dc140f0792d69260bfd64d
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 17:41:42 2011 -0400
Spellcheck lib/RT/CachedGroupMembers.pm
diff --git a/lib/RT/CachedGroupMembers.pm b/lib/RT/CachedGroupMembers.pm
index 3cd7fe0..195a617 100644
--- a/lib/RT/CachedGroupMembers.pm
+++ b/lib/RT/CachedGroupMembers.pm
@@ -150,9 +150,9 @@ sub LimitToMembersOfGroup {
=head2 LimitToGroupsWithMember PRINCIPAL_ID
-Takes a Principal Id as its only argument.
-Limits the current search to groups which contain PRINCIPAL_ID as a member or submember.
-This function gets used by GroupMember->Create to populate subgroups
+Takes a Principal Id as its only argument. Limits the current search to groups
+which contain PRINCIPAL_ID as a member, possibly recursively through subgroups.
+This function gets used by L<RT::GroupMember/Create> to populate subgroups.
=cut
-----------------------------------------------------------------------
More information about the Rt-commit
mailing list