From: Karen Etheridge Date: Sun, 8 Sep 2013 21:45:46 +0000 (-0700) Subject: spelling and pod fixes X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Types.git;a=commitdiff_plain;h=8bf27efd5d9f5df49e2977fc04a6abd4ea8a5aca spelling and pod fixes --- diff --git a/lib/MooseX/Types.pm b/lib/MooseX/Types.pm index 544d0e3..62a7054 100644 --- a/lib/MooseX/Types.pm +++ b/lib/MooseX/Types.pm @@ -18,6 +18,8 @@ use namespace::autoclean; use 5.008; my $UndefMsg = q{Action for type '%s' not yet defined in library '%s'}; +=pod + =head1 SYNOPSIS =head2 Library Definition @@ -119,7 +121,7 @@ my $UndefMsg = q{Action for type '%s' not yet defined in library '%s'}; The type system provided by Moose effectively makes all of its builtin type global, as are any types you declare with Moose. This means that every module -that declares a type named "PositiveInt" is sharing the same type object. This +that declares a type named C is sharing the same type object. This can be a problem when different parts of the code base want to use the same name for different things. @@ -424,7 +426,7 @@ sub type_export_generator { =head2 create_arged_type_constraint ($name, @args) -Given a String $name with @args find the matching typeconstraint and parameterize +Given a String $name with @args find the matching type constraint and parameterize it with @args. =cut @@ -532,7 +534,7 @@ Due to this stringification, the following will NOT work as you might think: subtype StrOrArrayRef => as Str | ArrayRef; -The 'StrOrArrayRef' will have its stringification activated this causes the +The C type will have its stringification activated -- this causes the subtype to not be created. Since the bareword type constraints are not strings you really should not try to treat them that way. You will have to use the ',' operator instead. The authors of this package realize that all the L @@ -564,7 +566,7 @@ targets. For example if you do: package Foo; use TypeAndSubExporter qw(MyStr); -You'll get a '"MyStr" is not exported by the TypeAndSubExporter module' error. +You'll get a C<< "MyStr" is not exported by the TypeAndSubExporter module >> error. It can be worked around by: - use Sub::Exporter -setup => { exports => [ qw(something) ] }; diff --git a/lib/MooseX/Types/Combine.pm b/lib/MooseX/Types/Combine.pm index 8c23ebe..cc85815 100644 --- a/lib/MooseX/Types/Combine.pm +++ b/lib/MooseX/Types/Combine.pm @@ -22,7 +22,7 @@ use Module::Runtime 'use_module'; Allows you to export types from multiple type libraries. -Libraries on the right side of the type libs passed to L +Libraries on the right end of the list passed to L take precedence over those on the left in case of conflicts. =cut diff --git a/lib/MooseX/Types/TypeDecorator.pm b/lib/MooseX/Types/TypeDecorator.pm index 0dd66ab..67dd3ce 100644 --- a/lib/MooseX/Types/TypeDecorator.pm +++ b/lib/MooseX/Types/TypeDecorator.pm @@ -112,9 +112,9 @@ sub __type_constraint { } } -=head2 isa +=head2 C -handle $self->isa since AUTOLOAD can't - this tries both the type constraint, +handle C<< $self->isa >> since C can't - this tries both the type constraint, and for a class type, the class. =cut diff --git a/lib/MooseX/Types/Util.pm b/lib/MooseX/Types/Util.pm index ea2c35c..579c9a4 100644 --- a/lib/MooseX/Types/Util.pm +++ b/lib/MooseX/Types/Util.pm @@ -46,7 +46,7 @@ sub filter_tags { This function allows you to introspect if a given type export is available I. This means that the C<$package> must have imported -a typeconstraint with the name C<$name>, and it must be still in its symbol +a type constraint with the name C<$name>, and it must be still in its symbol table. Two arguments are expected: