[Rt-commit] rt branch, 4.0/pod-spell, updated. rt-4.0.0rc6-166-gba9f43e
Shawn Moore
sartak at bestpractical.com
Thu Mar 17 20:02:43 EDT 2011
The branch, 4.0/pod-spell has been updated
via ba9f43e445d190d918180b41876286a04b9f4333 (commit)
via 42d677031c6766028a6d95a7e26a58d12652b76a (commit)
via 043411a64053004a4a5a9fb98874276ece92e763 (commit)
via f6fdc0362a59c04f4a98ec24ed1ceb5ed979c16b (commit)
via 6a1d21c10916ebd0f0994c3da499f5fd5e7cb679 (commit)
via 6e073528e438efb024bd5926f92a57db6a9c3c80 (commit)
via 9d22d90c2fbea60f0e3e20876b093b840c164bff (commit)
via 595f077af8972a72b8a9df5053164dfcd426f14f (commit)
via 8ea9b0bb46dc4422583980591ef221ad7c79aa5f (commit)
via 31ca085fadcc42dccdf00dbd3380a24191c09fc9 (commit)
via 24db916b3bd8907253191f3dd60d6973d3475bfe (commit)
via b332549f5907660e54435bd71705c5be6cd28840 (commit)
from 75fbf3efe1e3c27ce4473a4bfaf47351f573e2c8 (commit)
Summary of changes:
lib/RT/ObjectCustomFieldValue.pm | 12 +++---
lib/RT/Principal.pm | 4 +-
lib/RT/Queue.pm | 22 ++++++-----
lib/RT/Record.pm | 30 ++++++--------
lib/RT/SavedSearches.pm | 12 +++---
lib/RT/Scrip.pm | 24 ++++++------
lib/RT/ScripAction.pm | 10 -----
lib/RT/Scrips.pm | 2 +-
lib/RT/SearchBuilder.pm | 9 ++--
lib/RT/Shredder.pm | 78 +++++++-------------------------------
lib/RT/Squish.pm | 13 +++---
t/99-pod-spelling.t | 7 +++
12 files changed, 85 insertions(+), 138 deletions(-)
- Log -----------------------------------------------------------------
commit b332549f5907660e54435bd71705c5be6cd28840
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:22:12 2011 -0400
Spellcheck lib/RT/ObjectCustomFieldValue.pm
diff --git a/lib/RT/ObjectCustomFieldValue.pm b/lib/RT/ObjectCustomFieldValue.pm
index 4d6942c..f0bdf3f 100644
--- a/lib/RT/ObjectCustomFieldValue.pm
+++ b/lib/RT/ObjectCustomFieldValue.pm
@@ -390,9 +390,9 @@ sub _FillInTemplateURL {
=head2 ValueLinkURL
-Returns a filled in URL template for this ObjectCustomFieldValue, suitable for
-constructing a hyperlink in RT's webui. Returns undef if this custom field doesn't have
-a LinkValueTo
+Returns a filled-in URL template for this ObjectCustomFieldValue, suitable for
+constructing a hyperlink in RT's web interface. Returns C<undef> if this custom
+field doesn't have a C<LinkValueTo>.
=cut
@@ -405,9 +405,9 @@ sub LinkValueTo {
=head2 ValueIncludeURL
-Returns a filled in URL template for this ObjectCustomFieldValue, suitable for
-constructing a hyperlink in RT's webui. Returns undef if this custom field doesn't have
-a IncludeContentForValue
+Returns a filled-in URL template for this ObjectCustomFieldValue, suitable for
+constructing a hyperlink in RT's web interface. Returns C<undef> if this custom
+field doesn't have a C<IncludeContentForValue>.
=cut
commit 24db916b3bd8907253191f3dd60d6973d3475bfe
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:24:12 2011 -0400
Spellcheck lib/RT/Principal.pm
diff --git a/lib/RT/Principal.pm b/lib/RT/Principal.pm
index 8046d78..7d45d7f 100644
--- a/lib/RT/Principal.pm
+++ b/lib/RT/Principal.pm
@@ -228,7 +228,7 @@ sub RevokeRight {
=head2 HasRight (Right => 'right' Object => undef)
Checks to see whether this principal has the right "Right" for the Object
-specified. This takes the params:
+specified. This takes the following parameters:
=over 4
@@ -596,7 +596,7 @@ set of objects. Takes Right, EquiveObjects,
IncludeSystemRights and IncludeSuperusers arguments.
IncludeSystemRights is true by default, rights
-granted systemwide are ignored when IncludeSystemRights
+granted system-wide are ignored when IncludeSystemRights
is set to a false value.
IncludeSuperusers is true by default, SuperUser right
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 88b8abe..b856300 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -92,6 +92,7 @@ textbox
usernames
denormalizes
canonicalizes
+reinitializes
# RT JARGON
ACEs
commit 31ca085fadcc42dccdf00dbd3380a24191c09fc9
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:30:40 2011 -0400
Spellcheck lib/RT/Queue.pm
diff --git a/lib/RT/Queue.pm b/lib/RT/Queue.pm
index 4d55515..87f2273 100644
--- a/lib/RT/Queue.pm
+++ b/lib/RT/Queue.pm
@@ -281,8 +281,8 @@ sub SetLifecycle {
=head2 ValidateLifecycle NAME
-Takes a lifecycle name. Returns true if it's an ok name and such
-lifecycle is configured. Returns undef otherwise.
+Returns true if there is an L<RT::Lifecycle> with the given NAME. Returns
+C<undef> otherwise.
=cut
@@ -529,8 +529,8 @@ sub Load {
=head2 ValidateName NAME
-Takes a queue name. Returns true if it's an ok name for
-a new queue. Returns undef if there's already a queue by that name.
+Takes a queue name. Returns true if it's an acceptable name for
+a new queue. Returns C<undef> if there's already a queue by that name.
=cut
@@ -831,9 +831,9 @@ AddWatcher takes a parameter hash. The keys are as follows:
Type One of Requestor, Cc, AdminCc
-PrinicpalId The RT::Principal id of the user or group that's being added as a watcher
+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 Owner parameter to their User Id. Otherwise, set the Email parameter to their Email address.
@@ -960,8 +960,10 @@ Type (one of Requestor,Cc,AdminCc)
and one of
PrincipalId (an RT::Principal Id of the watcher you want to remove)
- OR
-Email (the email address of an existing wathcer)
+
+OR
+
+Email (the email address of an existing watcher)
=cut
@@ -1116,7 +1118,7 @@ sub AdminCc {
=head2 IsWatcher { Type => TYPE, PrincipalId => PRINCIPAL_ID }
-Takes a param hash with the attributes Type and PrincipalId
+Takes a paramhash with the attributes Type and PrincipalId
Type is one of Requestor, Cc, AdminCc and Owner
@@ -1242,7 +1244,7 @@ sub CurrentUserHasRight {
=head2 HasRight
-Takes a param hash with the fields 'Right' and 'Principal'.
+Takes a paramhash with the fields 'Right' and 'Principal'.
Principal defaults to the current user.
Returns true if the principal has that right for this queue.
Returns undef otherwise.
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index b856300..d854d49 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -111,6 +111,7 @@ portlet
portlets
RT's
Requestor
+requestor
Requestors
crontool
lifecycle
commit 8ea9b0bb46dc4422583980591ef221ad7c79aa5f
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:34:48 2011 -0400
Spellcheck lib/RT/Record.pm
diff --git a/lib/RT/Record.pm b/lib/RT/Record.pm
index 52f9ab6..0f43d4a 100644
--- a/lib/RT/Record.pm
+++ b/lib/RT/Record.pm
@@ -97,8 +97,8 @@ sub _PrimaryKey { 'id' }
=head2 Id
-Override L<DBIx::SearchBuilder/Id> to avoid a few lookups RT doesn't do
-on a very common codepath
+Override L<DBIx::SearchBuilder/Id> to break encapsulation for a very hot
+codepath.
C<id> is an alias to C<Id> and is the preferred way to call this method.
@@ -261,11 +261,11 @@ sub _Handle { return $RT::Handle }
=head2 Create PARAMHASH
Takes a PARAMHASH of Column -> Value pairs.
-If any Column has a Validate$PARAMNAME subroutine defined and the
+If any Column has a C<Validate$PARAMNAME> subroutine defined and the
value provided doesn't pass validation, this routine returns
an error.
-If this object's table has any of the following atetributes defined as
+If this object's table has any of the following attributes defined as
'Auto', this routine will automatically fill in their values.
=cut
@@ -605,7 +605,7 @@ sub ValidateName {
=head2 SQLType attribute
-return the SQL type for the attribute 'attribute' as stored in _ClassAccessible
+Returns the SQL type for the attribute 'attribute' as stored in L</_ClassAccessible>.
=cut
@@ -613,9 +613,7 @@ sub SQLType {
my $self = shift;
my $field = shift;
- return ($self->_Accessible($field, 'type'));
-
-
+ return $self->_Accessible($field, 'type');
}
sub __Value {
@@ -1094,11 +1092,10 @@ sub UnresolvedDependencies {
=head2 AllDependedOnBy
-Returns an array of RT::Ticket objects which (directly or indirectly)
-depends on this ticket; takes an optional 'Type' argument in the param
-hash, which will limit returned tickets to that type, as well as cause
-tickets with that type to serve as 'leaf' nodes that stops the recursive
-dependency search.
+Returns an array of RT::Ticket objects which (directly or indirectly) depends
+on this ticket; takes an optional 'Type' argument in the paramhash, which will
+limit returned tickets to that type, as well as cause tickets with that type to
+serve as 'leaf' nodes that stops the recursive dependency search.
=cut
@@ -1111,10 +1108,9 @@ sub AllDependedOnBy {
=head2 AllDependsOn
Returns an array of RT::Ticket objects which this ticket (directly or
-indirectly) depends on; takes an optional 'Type' argument in the param
-hash, which will limit returned tickets to that type, as well as cause
-tickets with that type to serve as 'leaf' nodes that stops the
-recursive dependency search.
+indirectly) depends on; takes an optional 'Type' argument in the paramhash,
+which will limit returned tickets to that type, as well as cause tickets with
+that type to serve as 'leaf' nodes that stops the recursive dependency search.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index d854d49..df869b1 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -26,6 +26,7 @@ Zakirov
# ENGLISH
one's
+multi
# PROGRAMMING JARGON
API
@@ -93,6 +94,7 @@ usernames
denormalizes
canonicalizes
reinitializes
+codepath
# RT JARGON
ACEs
commit 595f077af8972a72b8a9df5053164dfcd426f14f
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:36:51 2011 -0400
Spellcheck lib/RT/SavedSearches.pm
diff --git a/lib/RT/SavedSearches.pm b/lib/RT/SavedSearches.pm
index 069bf92..19c2961 100644
--- a/lib/RT/SavedSearches.pm
+++ b/lib/RT/SavedSearches.pm
@@ -78,12 +78,12 @@ sub RecordClass {
=head2 LimitToPrivacy
-Takes two argumets: a privacy string, of the format "<class>-<id>", as
-produced by RT::SavedSearch::Privacy(); and a type string, as produced
-by RT::SavedSearch::Type(). The SavedSearches object will load the
-searches belonging to that user or group that are of the type
-specified. If no type is specified, all the searches belonging to the
-user/group will be loaded. Repeated calls to the same object should DTRT.
+Takes two arguments: a privacy string, of the format C<$class-$id>, as produced
+by C<< RT::SavedSearch->Privacy >>; and a type string, as produced by
+C<< RT::SavedSearch->Type >>. The SavedSearches object will load the searches
+belonging to that user or group that are of the specified type. If no type is
+specified, all the searches belonging to the user or group will be loaded.
+Repeated calls to the same object should do the right thing.
=cut
commit 9d22d90c2fbea60f0e3e20876b093b840c164bff
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:41:02 2011 -0400
Spellcheck lib/RT/Scrip.pm
diff --git a/lib/RT/Scrip.pm b/lib/RT/Scrip.pm
index 5d4e5e8..1e326e8 100644
--- a/lib/RT/Scrip.pm
+++ b/lib/RT/Scrip.pm
@@ -95,8 +95,9 @@ Creates a new entry in the Scrips table. Takes a paramhash with:
-Returns (retval, msg);
-retval is 0 for failure or scrip id. msg is a textual description of what happened.
+Returns (id, message);
+C<id> is 0 on failure, or scrip ID on success. message is a textual description
+of what happened.
=cut
@@ -210,7 +211,7 @@ sub Delete {
=head2 QueueObj
-Retuns an RT::Queue object with this Scrip's queue
+Returns the L<RT::Queue> object for this scrip's queue.
=cut
@@ -229,7 +230,7 @@ sub QueueObj {
=head2 ActionObj
-Retuns an RT::Action object with this Scrip\'s Action
+Returns the L<RT::ScripAction> object for this scrip's action.
=cut
@@ -252,7 +253,7 @@ sub ActionObj {
=head2 ConditionObj
-Retuns an L<RT::ScripCondition> object with this Scrip's IsApplicable
+Returns the L<RT::ScripCondition> object for this scrip's condition.
=cut
@@ -281,7 +282,7 @@ sub LoadModules {
=head2 TemplateObj
-Retuns an RT::Template object with this Scrip\'s Template
+Returns the L<RT::Template> object for this scrip's template.
=cut
@@ -541,8 +542,7 @@ sub _Value {
=head2 CurrentUserHasRight
-Helper menthod for HasRight. Presets Principal to CurrentUser then
-calls HasRight.
+Wrapper method for L</HasRight>, defaulting C<Principal> to the current user.
=cut
@@ -558,7 +558,7 @@ sub CurrentUserHasRight {
=head2 HasRight
-Takes a param-hash consisting of "Right" and "Principal" Principal is
+Takes a paramhash consisting of "Right" and "Principal" Principal is
an RT::User object or an RT::CurrentUser object. "Right" is a textual
Right string that applies to Scrips.
@@ -589,12 +589,12 @@ sub HasRight {
=head2 CompileCheck
This routine compile-checks the custom prepare, commit, and is-applicable code
-to see if they are syntactically valid Perl. We eval them in a codeblock to
+to see if they are syntactically valid Perl. We eval them in a code block to
avoid actually executing the code.
If one of the fields has a compile error, only the first is reported.
-Returns an (ok, message) pair.
+Returns an (OK, message) pair.
=cut
@@ -612,7 +612,7 @@ sub CompileCheck {
next if !$@;
my $error = $@;
- return (0, $self->loc("Couldn't compile [_1] codeblock '[_2]': [_3]", $method, $code, $error));
+ return (0, $self->loc("Couldn't compile [_1] code block '[_2]': [_3]", $method, $code, $error));
}
}
commit 6e073528e438efb024bd5926f92a57db6a9c3c80
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:41:29 2011 -0400
Remove stale TODO; I don't think ScripActions are going anywhere
diff --git a/lib/RT/ScripAction.pm b/lib/RT/ScripAction.pm
index c679a91..b5f879a 100644
--- a/lib/RT/ScripAction.pm
+++ b/lib/RT/ScripAction.pm
@@ -258,16 +258,6 @@ sub DESTROY {
$self->{'TemplateObj'} = undef;
}
-=head2 TODO
-
-Between this, RT::Scrip and RT::Action::*, we need to be able to get rid of a
-class. This just reeks of too much complexity -- jesse
-
-=cut
-
-
-
-
=head2 id
Returns the current value of id.
commit 6a1d21c10916ebd0f0994c3da499f5fd5e7cb679
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:42:02 2011 -0400
Spellcheck lib/RT/Scrips.pm
diff --git a/lib/RT/Scrips.pm b/lib/RT/Scrips.pm
index 077dbfe..2e25e4f 100644
--- a/lib/RT/Scrips.pm
+++ b/lib/RT/Scrips.pm
@@ -305,7 +305,7 @@ sub _SetupSourceObjects {
=head2 _FindScrips
-Find only the apropriate scrips for whatever we're doing now. Order them
+Find only the appropriate scrips for whatever we're doing now. Order them
by their description. (Most common use case is to prepend a number to the
description, forcing the scrips to display and run in ascending alphanumerical
order.)
commit f6fdc0362a59c04f4a98ec24ed1ceb5ed979c16b
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:43:19 2011 -0400
Spellcheck lib/RT/SearchBuilder.pm
diff --git a/lib/RT/SearchBuilder.pm b/lib/RT/SearchBuilder.pm
index 01f08ef..dfde46b 100644
--- a/lib/RT/SearchBuilder.pm
+++ b/lib/RT/SearchBuilder.pm
@@ -212,9 +212,9 @@ sub LimitCustomField {
=head2 Limit PARAMHASH
-This Limit sub calls SUPER::Limit, but defaults "CASESENSITIVE" to 1, thus
+This Limit sub calls C<SUPER::Limit>, but defaults "CASESENSITIVE" to 1, thus
making sure that by default lots of things don't do extra work trying to
-match lower(colname) agaist lc($val);
+match C<lower(colname)> against C<lc($val)>;
=cut
@@ -286,8 +286,9 @@ sub _DoCount {
=head2 ColumnMapClassName
ColumnMap needs a Collection name to load the correct list display.
-Depluralization is hard, so provide an easy way to correct the naive
-algorithm that this code uses.
+
+Depluralization is hard, so you can easily correct the naive
+algorithm that this code uses in your subclass.
=cut
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index df869b1..49ec459 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -27,6 +27,7 @@ Zakirov
# ENGLISH
one's
multi
+depluralization
# PROGRAMMING JARGON
API
commit 043411a64053004a4a5a9fb98874276ece92e763
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:49:19 2011 -0400
Remove a lot of Shredder's old doc that doesn't fit in core RT
diff --git a/lib/RT/Shredder.pm b/lib/RT/Shredder.pm
index d73db13..36cb00f 100644
--- a/lib/RT/Shredder.pm
+++ b/lib/RT/Shredder.pm
@@ -799,48 +799,6 @@ __END__
=head1 NOTES
-=head2 Database transactions support
-
-Since 0.03_01 RT::Shredder uses database transactions and should be
-much safer to run on production servers.
-
-=head2 Foreign keys
-
-Mainstream RT doesn't use FKs, but at least I posted DDL script that creates them
-in mysql DB, note that if you use FKs then this two valid keys don't allow delete
-Tickets because of bug in MySQL:
-
- ALTER TABLE Tickets ADD FOREIGN KEY (EffectiveId) REFERENCES Tickets(id);
- ALTER TABLE CachedGroupMembers ADD FOREIGN KEY (Via) REFERENCES CachedGroupMembers(id);
-
-L<http://bugs.mysql.com/bug.php?id=4042>
-
-=head1 BUGS AND HOW TO CONTRIBUTE
-
-We need your feedback in all cases: if you use it or not,
-is it works for you or not.
-
-=head2 Testing
-
-Don't skip C<make test> step while install and send me reports if it's fails.
-Add your own tests, it's easy enough if you've writen at list one perl script
-that works with RT. Read more about testing in F<t/utils.pl>.
-
-=head2 Reporting
-
-Send reports to L</AUTHOR> or to the RT mailing lists.
-
-=head2 Documentation
-
-Many bugs in the docs: insanity, spelling, gramar and so on.
-Patches are wellcome.
-
-=head2 Todo
-
-Please, see Todo file, it has some technical notes
-about what I plan to do, when I'll do it, also it
-describes some problems code has.
-
=head2 Repository
Since RT-3.7 shredder is a part of the RT distribution.
@@ -853,14 +811,6 @@ L<https://opensvn.csie.org/rtx_shredder>
Ruslan U. Zakirov <Ruslan.Zakirov at gmail.com>
-=head1 COPYRIGHT
-
-This program is free software; you can redistribute
-it and/or modify it under the same terms as Perl itself.
-
-The full text of the license can be found in the
-Perl distribution.
-
=head1 SEE ALSO
L<rt-shredder>, L<rt-validator>
commit 42d677031c6766028a6d95a7e26a58d12652b76a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:50:16 2011 -0400
Spellcheck lib/RT/Shredder.pm
diff --git a/lib/RT/Shredder.pm b/lib/RT/Shredder.pm
index 36cb00f..66b52a5 100644
--- a/lib/RT/Shredder.pm
+++ b/lib/RT/Shredder.pm
@@ -106,9 +106,9 @@ See also 'rt-shredder --help'.
Shredder's WebUI integrates into RT's WebUI. You can find it in the
Configuration->Tools->Shredder tab. The interface is similar to the
-CLI and gives you the same functionality. You can find 'Shredder' link
-at the bottom of tickets search results, so you could wipeout tickets
-in the way similar to the bulk update.
+command-line interface and gives you the same functionality. You can find the
+'Shredder' link at the bottom of tickets search results, so you can wipeout
+tickets much in the same way that you would bulk update them.
=head1 DATA STORAGE AND BACKUPS
@@ -171,7 +171,7 @@ RT objects and classes. The API is not well documented yet, but you
can find usage examples in L<rt-shredder> and the
F<lib/t/regression/shredder/*.t> test files.
-However, here is a small example that do the same action as in CLI
+However, here is a small example that do the same action as in the command-line
example from L</SYNOPSIS>:
use RT::Shredder;
@@ -257,7 +257,7 @@ our @SUPPORTED_OBJECTS = qw(
RT::Shredder::Init( %default_options );
C<RT::Shredder::Init()> should be called before creating an
-RT::Shredder object. It iniitalizes RT and loads the RT
+RT::Shredder object. It initializes RT and loads the RT
configuration.
%default_options are passed to every C<<RT::Shredder->new>> call.
@@ -302,12 +302,12 @@ sub _Init
=head4 CastObjectsToRecords( Objects => undef )
-Cast objects to the C<RT::Record> objects or its ancesstors.
+Cast objects into C<RT::Record> objects or its ancestors.
Objects can be passed as SCALAR (format C<< <class>-<id> >>),
-ARRAY, C<RT::Record> ancesstors or C<RT::SearchBuilder> ancesstor.
+ARRAY, C<RT::Record> ancestors or C<RT::SearchBuilder> ancestor.
-Most methods that takes C<Objects> argument use this method to
-cast argument value to list of records.
+Most methods that take an C<Objects> argument use this method to
+cast the argument's value into a list of records.
Returns an array of records.
@@ -396,8 +396,8 @@ sub PutObjects
Puts record object into cache and returns its cache entry.
-B<NOTE> that this method support B<only C<RT::Record> object or its ancesstor
-objects>, if you want put mutliple objects or objects represented by different
+B<NOTE> that this method support B<only C<RT::Record> object or its ancestor
+objects>, if you want put multiple objects or objects represented by different
classes then use C<PutObjects> method instead.
=cut
@@ -628,11 +628,11 @@ path by next rules:
* if C<FileName> has C<XXXX> (exactly four uppercase C<X> letters) then it would be changed with digits from 0000 to 9999 range, with first one free value;
-* if C<FileName> has C<%T> then it would be replaced with the current date and time in the C<YYYY-MM-DDTHH:MM:SS> format. Note that using C<%t> may still generate not unique names, using C<XXXX> recomended.
+* if C<FileName> has C<%T> then it would be replaced with the current date and time in the C<YYYY-MM-DDTHH:MM:SS> format. Note that using C<%t> may still generate not unique names, using C<XXXX> recommended.
* if C<FromStorage> argument is true (default behaviour) then result path would always be relative to C<StoragePath>;
-* if C<FromStorage> argument is false then result would be relative to the current dir unless it's already absolute path.
+* if C<FromStorage> argument is false then result would be relative to the current directory unless it's already absolute path.
Returns an absolute path of the file.
@@ -714,7 +714,7 @@ sub GetFileName
=head4 StoragePath
-Returns an absolute path to the storage dir. See
+Returns an absolute path to the storage directory. See
L<CONFIGURATION/$ShredderStoragePath>.
See also description of the L</GetFileName> method.
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
index 49ec459..e814c1d 100644
--- a/t/99-pod-spelling.t
+++ b/t/99-pod-spelling.t
@@ -28,6 +28,7 @@ Zakirov
one's
multi
depluralization
+auditability
# PROGRAMMING JARGON
API
@@ -127,3 +128,4 @@ subvalues
formatter
formatters
lookup
+wipeout
commit ba9f43e445d190d918180b41876286a04b9f4333
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Thu Mar 17 19:52:42 2011 -0400
Spellcheck lib/RT/Squish.pm
diff --git a/lib/RT/Squish.pm b/lib/RT/Squish.pm
index d54dfac..130b6e6 100644
--- a/lib/RT/Squish.pm
+++ b/lib/RT/Squish.pm
@@ -90,8 +90,9 @@ sub new {
=head2 Squish
-virtual method which does nothing,
-you need to implement this method in subclasses.
+Virtual method which does nothing,
+
+You must implement this method in subclasses.
=cut
@@ -102,19 +103,19 @@ sub Squish {
=head2 Content
-squished content
+The squished content
=head2 Key
-md5 of the squished content
+MD5 digest of the squished content
=head2 ModifiedTime
-created time of squished content, i.e. seconds since 00:00:00 UTC, January 1, 1970
+Creation time of the squished content, expressed as seconds since epoch
=head2 ModifiedTimeString
-created time of squished content, with HTTP::Date format
+Creation time of the squished content, expressed as L<HTTP::Date> format
=cut
-----------------------------------------------------------------------
More information about the Rt-commit
mailing list