From: Karen Etheridge Date: Wed, 17 Jul 2013 03:03:42 +0000 (-0700) Subject: make spelling tests pass X-Git-Tag: v0.36-TRIAL~1^2~3 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Storage.git;a=commitdiff_plain;h=8af2c2b01fe7c63f2748d1b1deca3198c8974b7f make spelling tests pass --- diff --git a/lib/MooseX/Storage.pm b/lib/MooseX/Storage.pm index 32f6aa5..4dfc86d 100644 --- a/lib/MooseX/Storage.pm +++ b/lib/MooseX/Storage.pm @@ -178,7 +178,7 @@ The first (base) level is C and C. In this level the class is serialized into a Perl HASH reference, it is tagged with the class name and each instance attribute is stored. Very simple. -This level is not optional, it is the bare minumum that +This level is not optional, it is the bare minimum that MooseX::Storage provides and all other levels build on top of this. See L for the fundamental implementation and @@ -194,6 +194,8 @@ specific serialization format and Perl land. This level is optional, if you don't want/need it, you don't have to have it. You can just use C/C instead. +=for stopwords io + =item B The third (io) level is C and C. In this level we are reading @@ -218,7 +220,7 @@ The following traits are currently bundled with C: =item OnlyWhenBuilt -Only attributes that have been built (ie, where the predicate returns +Only attributes that have been built (i.e., where the predicate returns 'true') will be serialized. This avoids any potentially expensive computations. See L for details. @@ -238,9 +240,11 @@ MooseX::Storage enabled objects are supported. With Array and Hash references the first level down is inspected and any objects found are serialized/deserialized for you. We do not do -this recusively by default, however this feature may become an +this recursively by default, however this feature may become an option eventually. +=for stopwords subtypes + The specific serialize/deserialize routine is determined by the Moose type constraint a specific attribute has. In most cases subtypes of the supported types are handled correctly, and there is a facility @@ -290,6 +294,8 @@ that is not under the default namespace prefix, start with an equal sign: Storage(format => '=My::Private::JSONFormat'); +=for stopwords parameterized + To use a parameterized role (for which, see L) you can pass an arrayref of the role name (in short or long form, as above) and its parameters: @@ -314,6 +320,8 @@ parameters: =back +=for stopwords TODO + =head1 TODO This module needs docs and probably a Cookbook of some kind as well. @@ -347,3 +355,5 @@ This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut + + diff --git a/lib/MooseX/Storage/Deferred.pm b/lib/MooseX/Storage/Deferred.pm index 748d4fb..f0b9572 100644 --- a/lib/MooseX/Storage/Deferred.pm +++ b/lib/MooseX/Storage/Deferred.pm @@ -64,6 +64,8 @@ __END__ =head1 NAME +=for stopwords undecisive + MooseX::Storage::Deferred - A role for undecisive programmers =head1 SYNOPSIS @@ -112,6 +114,8 @@ SYNOPSIS for more info) =item I +=for stopwords JSONpm + =item I =item I diff --git a/lib/MooseX/Storage/Engine/Trait/OnlyWhenBuilt.pm b/lib/MooseX/Storage/Engine/Trait/OnlyWhenBuilt.pm index 427dfb4..f7f0199 100644 --- a/lib/MooseX/Storage/Engine/Trait/OnlyWhenBuilt.pm +++ b/lib/MooseX/Storage/Engine/Trait/OnlyWhenBuilt.pm @@ -54,7 +54,7 @@ MooseX::Storage::Engine::Trait::OnlyWhenBuilt - An engine trait to bypass serial Sometimes you don't want a particular attribute to be part of the serialization if it has not been built yet. If you invoke C as outlined in the C, only attributes that have been built -(ie, where the predicate returns 'true') will be serialized. +(i.e., where the predicate returns 'true') will be serialized. This avoids any potentially expensive computations. This trait is applied to an instance of L, for the diff --git a/lib/MooseX/Storage/Format/Storable.pm b/lib/MooseX/Storage/Format/Storable.pm index 0e3f8c2..e5eb9af 100644 --- a/lib/MooseX/Storage/Format/Storable.pm +++ b/lib/MooseX/Storage/Format/Storable.pm @@ -54,10 +54,14 @@ MooseX::Storage::Format::Storable - A Storable serialization role =head1 DESCRIPTION +=for stopwords IPC + This module will C and C Moose classes using Storable. It uses C by default so that it can be easily used in IPC scenarios across machines or just locally. +=for stopwords Storable's + One important thing to note is that this module does not mix well with the IO modules. The structures that C and C deal with are Storable's memory representation, and (as far as I know) that diff --git a/lib/MooseX/Storage/IO/StorableFile.pm b/lib/MooseX/Storage/IO/StorableFile.pm index 0e5bd9f..a42e3f6 100644 --- a/lib/MooseX/Storage/IO/StorableFile.pm +++ b/lib/MooseX/Storage/IO/StorableFile.pm @@ -66,7 +66,7 @@ across machines or just locally. One important thing to note is that this module does not mix well with the other Format modules. Since Storable serialized perl data -structures in it's own format, those roles are lagely unnecessary. +structures in it's own format, those roles are largely unnecessary. However, there is always the possibility that having a set of C hooks can be useful, so because of that this module diff --git a/lib/MooseX/Storage/Meta/Attribute/DoNotSerialize.pm b/lib/MooseX/Storage/Meta/Attribute/DoNotSerialize.pm index befe62d..af4f149 100644 --- a/lib/MooseX/Storage/Meta/Attribute/DoNotSerialize.pm +++ b/lib/MooseX/Storage/Meta/Attribute/DoNotSerialize.pm @@ -40,6 +40,7 @@ MooseX::Storage::Meta::Attribute::DoNotSerialize - A custom meta-attribute to by =head1 DESCRIPTION +=for stopwords culted Sometimes you don't want a particular attribute to be part of the serialization, in this case, you want to make sure that attribute diff --git a/lib/MooseX/Storage/Meta/Attribute/Trait/DoNotSerialize.pm b/lib/MooseX/Storage/Meta/Attribute/Trait/DoNotSerialize.pm index 834fdae..78aff02 100644 --- a/lib/MooseX/Storage/Meta/Attribute/Trait/DoNotSerialize.pm +++ b/lib/MooseX/Storage/Meta/Attribute/Trait/DoNotSerialize.pm @@ -38,6 +38,8 @@ MooseX::Storage::Meta::Attribute::Trait::DoNotSerialize - A custom meta-attribut =head1 DESCRIPTION +=for stopwords culted + Sometimes you don't want a particular attribute to be part of the serialization, in this case, you want to make sure that attribute uses this custom meta-attribute-trait. See the SYNOPSIS for a nice diff --git a/lib/MooseX/Storage/Traits/DisableCycleDetection.pm b/lib/MooseX/Storage/Traits/DisableCycleDetection.pm index 6178af8..7c9d15a 100644 --- a/lib/MooseX/Storage/Traits/DisableCycleDetection.pm +++ b/lib/MooseX/Storage/Traits/DisableCycleDetection.pm @@ -57,6 +57,8 @@ references, so if you know what you are doing, you can bypass this check. This trait is applied to all objects that inherit from it. To use this on a per-case basis, see C in L. +=for stopwords culted + See the SYNOPSIS for a nice example that can be easily cargo-culted. =head1 METHODS diff --git a/lib/MooseX/Storage/Traits/OnlyWhenBuilt.pm b/lib/MooseX/Storage/Traits/OnlyWhenBuilt.pm index 610bde0..867e99b 100644 --- a/lib/MooseX/Storage/Traits/OnlyWhenBuilt.pm +++ b/lib/MooseX/Storage/Traits/OnlyWhenBuilt.pm @@ -60,9 +60,11 @@ MooseX::Storage::Traits::OnlyWhenBuilt - A custom trait to bypass serialization Sometimes you don't want a particular attribute to be part of the serialization if it has not been built yet. If you invoke C as outlined in the C, only attributes that have been built -(ie, where the predicate returns 'true') will be serialized. +(i.e., where the predicate returns 'true') will be serialized. This avoids any potentially expensive computations. +=for stopwords culted + See the SYNOPSIS for a nice example that can be easily cargo-culted. =head1 METHODS diff --git a/lib/MooseX/Storage/Util.pm b/lib/MooseX/Storage/Util.pm index 2e86daf..20da8db 100644 --- a/lib/MooseX/Storage/Util.pm +++ b/lib/MooseX/Storage/Util.pm @@ -71,7 +71,7 @@ __END__ =head1 NAME -MooseX::Storage::Util - A MooseX::Storage swiss-army chainsaw +MooseX::Storage::Util - A MooseX::Storage Swiss Army chainsaw =head1 DESCRIPTION @@ -124,6 +124,8 @@ found in the key for you. =back +=for stopwords TODO + =head1 TODO Add more stuff to this module :)