From: Karen Etheridge Date: Sat, 21 Jul 2012 19:16:37 +0000 (-0700) Subject: minor doc cleanup X-Git-Tag: v1.000001~2 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=52e8f144aff26f074f1376deb28e4df5839c001f;p=gitmo%2FMoo.git minor doc cleanup --- diff --git a/Changes b/Changes index 667e9cb..1724c99 100644 --- a/Changes +++ b/Changes @@ -1,3 +1,4 @@ + - documentation tweaks and cleanup - ignore required when default or builder is present - document Moo versus Any::Moose in brief with article link - remove quote_sub from SYNOPSIS and has docs, expand Sub::Quote section diff --git a/lib/Moo.pm b/lib/Moo.pm index 2fd9419..35f72b5 100644 --- a/lib/Moo.pm +++ b/lib/Moo.pm @@ -211,7 +211,7 @@ Moo - Minimalist Object Orientation (with Moose compatiblity) 1; -and else where +And elsewhere: my $full = Cat::Food->new( taste => 'DELICIOUS.', @@ -226,13 +226,13 @@ and else where =head1 DESCRIPTION This module is an extremely light-weight subset of L optimised for -rapid startup and pay for what you use. +rapid startup and "pay only for what you use". It also avoids depending on any XS modules to allow simple deployments. The -name C is based on the idea that it provides almost -but not quite- two +name C is based on the idea that it provides almost -- but not quite -- two thirds of L. -Unlike C this module does not aim at full compatibility with +Unlike L this module does not aim at full compatibility with L's surface syntax, preferring instead of provide full interoperability via the metaclass inflation capabilites described in L. @@ -253,14 +253,14 @@ I've tried several times to use L but it's 3x the size of Moo and takes longer to load than most of my Moo based CGI scripts take to run. If you don't want L, you don't want "less metaprotocol" like L, -you want "as little as possible" - which means "no metaprotocol", which is +you want "as little as possible" -- which means "no metaprotocol", which is what Moo provides. Better still, if you install and load L, we set up metaclasses for your L classes and L roles, so you can use them in L code without ever noticing that some of your codebase is using L. -Hence - Moo exists as its name - Minimal Object Orientation - with a pledge +Hence, Moo exists as its name -- Minimal Object Orientation -- with a pledge to make it smooth to upgrade to L when you need more than minimal features. @@ -276,7 +276,7 @@ Extending a L class or consuming a L will also work. So will extending a L class or consuming a L - but note that we don't provide L metaclasses or metaroles so the other way around doesn't work. This feature exists for L users porting to -L, enabling L users to use L classes is not a priority for us. +L; enabling L users to use L classes is not a priority for us. This means that there is no need for anything like L for Moo code - Moo and Moose code should simply interoperate without problem. To @@ -432,7 +432,7 @@ name of the attribute. =item * isa -Takes a coderef which is meant to validate the attribute. Unlike L Moo +Takes a coderef which is meant to validate the attribute. Unlike L, Moo does not include a basic type system, so instead of doing C<< isa => 'Num' >>, one should do @@ -473,8 +473,8 @@ do something like the following: $_[0] + 1 unless $_[0] % 2 }, -Note that L will always fire your coercion - this is to permit -isa entries to be used purely for bug trapping, whereas coercions are +Note that L will always fire your coercion: this is to permit +C entries to be used purely for bug trapping, whereas coercions are always structural to your code. We do, however, apply any supplied C check after the coercion has run to ensure that it returned a valid value. @@ -514,7 +514,7 @@ supported. L -=item * default +=item * C Takes a coderef which will get called with $self as its only argument to populate an attribute if no value is supplied to the constructor - or @@ -527,7 +527,7 @@ existence. L -=item * predicate +=item * C Takes a method name which will return true if an attribute has a value. @@ -536,7 +536,7 @@ C if your attribute's name does not start with an underscore, or <_has_${attr_name_without_the_underscore}> if it does. This feature comes from L. -=item * builder +=item * C Takes a method name which will be called to create the attribute - functions exactly like default except that instead of calling @@ -550,7 +550,7 @@ Moo will call If you set this to just C<1>, the predicate is automatically named C<_build_${attr_name}>. This feature comes from L. -=item * clearer +=item * C Takes a method name which will clear the attribute. @@ -559,35 +559,35 @@ C if your attribute's name does not start with an underscore, or <_clear_${attr_name_without_the_underscore}> if it does. This feature comes from L. -=item * lazy +=item * C B. Set this if you want values for the attribute to be grabbed lazily. This is usually a good idea if you have a L which requires another attribute to be set. -=item * required +=item * C B. Set this if the attribute must be passed on instantiation. -=item * reader +=item * C The value of this attribute will be the name of the method to get the value of the attribute. If you like Java style methods, you might set this to C -=item * writer +=item * C The value of this attribute will be the name of the method to set the value of the attribute. If you like Java style methods, you might set this to -C +C. -=item * weak_ref +=item * C B. Set this if you want the reference that the attribute contains to be weakened; use this when circular references are possible, which will cause leaks. -=item * init_arg +=item * C Takes the name of the key to look for at instantiation time of the object. A common use of this is to make an underscored attribute have a non-underscored @@ -653,11 +653,11 @@ which will be inlined as } See L for more information, including how to pass lexical -captures that will also be compiled in to the subroutine. +captures that will also be compiled into the subroutine. =head1 INCOMPATIBILITIES WITH MOOSE -There is no built in type system. C is verified with a coderef, if you +There is no built-in type system. C is verified with a coderef; if you need complex types, just make a library of coderefs, or better yet, functions that return quoted subs. L provides a similar API to L so that you can write @@ -704,7 +704,7 @@ L only supports coderefs, because doing otherwise is usually a mistake anyway. C is not supported; you are instead encouraged to use the -C 'lazy'> option supported by L and L. +C<< is => 'lazy' >> option supported by L and L. C is not supported since the author considers it a bad idea. @@ -713,7 +713,7 @@ but is otherwise ignored. Then again, L ignores it as well, so this is arguably not an incompatibility. Since C does not require C to be defined but L does -require it, the metaclass inflation for coerce-alone is a trifle insane +require it, the metaclass inflation for coerce alone is a trifle insane and if you attempt to subtype the result will almost certainly break. Handling of warnings: when you C we enable FATAL warnings. The nearest diff --git a/lib/Moo/Role.pm b/lib/Moo/Role.pm index fdafb11..628258d 100644 --- a/lib/Moo/Role.pm +++ b/lib/Moo/Role.pm @@ -286,7 +286,7 @@ Moo::Role - Minimal Object Orientation support for Roles 1; -else where +And elsewhere: package Some::Class;