[Moose-commits] r7491 - Moose/trunk/lib/Moose/Manual

autarch at code2.0beta.co.uk autarch at code2.0beta.co.uk
Tue Feb 3 16:39:00 GMT 2009


Author: autarch
Date: 2009-02-03 08:39:00 -0800 (Tue, 03 Feb 2009)
New Revision: 7491

Modified:
   Moose/trunk/lib/Moose/Manual/Construction.pod
Log:
Small tweaks in the Construction manual


Modified: Moose/trunk/lib/Moose/Manual/Construction.pod
===================================================================
--- Moose/trunk/lib/Moose/Manual/Construction.pod	2009-02-03 16:29:05 UTC (rev 7490)
+++ Moose/trunk/lib/Moose/Manual/Construction.pod	2009-02-03 16:39:00 UTC (rev 7491)
@@ -9,10 +9,10 @@
 B<You do not need to define a C<new()> method for your classes!>
 
 When you C<use Moose> in your class, you will become a subclass of
-C<Moose::Object>, which provides a C<new> method for you. And if you
+C<Moose::Object>, which provides a C<new> method for you. If you
 follow our recommendations in L<Moose::Manual::BestPractices> and make
 your class immutable, then you actually get a class-specific C<new>
-method genreated in your class.
+method "inlined" in your class.
 
 =head1 OBJECT CONSTRUCTION AND ATTRIBUTES
 
@@ -24,22 +24,22 @@
 
 =head1 OBJECT CONSTRUCTION HOOKS
 
-Sometimes you need to hook into object construction. Some common needs
-are validating an object's state, logging, and allowing non-hash(ref)
-constructor arguments. Moose provides hooks for these needs with the
-C<BUILD> and C<BUILDARGS> methods.
+Moose lets you hook into object construction. You can validate an
+object's state, do logging, or maybe allow non-hash(ref) constructor
+arguments. You can do this by creating C<BUILD> and/or C<BUILDARGS>
+methods.
 
-If these are defined in your class, then Moose will arrange for them
-to be called as part of the object construction process.
+If these methods exist in your class, Moose will arrange for them to
+be called as part of the object construction process.
 
 =head2 BUILDARGS
 
-The C<BUILDARGS> method is called I<before> an object is created, and
-is therefore called as a class method. It will receive all of the
-arguments that were passed to C<new> I<as-is>. Your C<BUILDARGS>
-method must then return a hash reference. This hash reference will be
-used to construct the object, so it should contain keys matching your
-attributes' names (well, C<init_arg>s).
+The C<BUILDARGS> method is called as a class method I<before> an
+object is created. It will receive all of the arguments that were
+passed to C<new> I<as-is>, and is expected to return a hash
+reference. This hash reference will be used to construct the object,
+so it should contain keys matching your attributes' names (well,
+C<init_arg>s).
 
 One common use for C<BUILDARGS> is to accomodate a non-hash(ref)
 calling style. For example, we might want to allow our Person class to
@@ -63,15 +63,15 @@
 
 Note the call to C<SUPER::BUILDARGS>. This will call the default
 C<BUILDARGS> in C<Moose::Object>. This method handles distinguishing
-between a hash reference and a plain hash, so you don't have to.
+between a hash reference and a plain hash for you.
 
 =head2 BUILD
 
 The C<BUILD> method is called I<after> an object is created. There are
-many potential uses for a C<BUILD> method. One of the most common is
-to check that the object state makes sense. While we can validate
-individual attributes through the use of types, we can't validate the
-state of a whole object that way.
+ways to use a C<BUILD> method. One of the most common is to check that
+the object state is valid. While we can validate individual attributes
+through the use of types, we can't validate the state of a whole
+object that way.
 
   sub BUILD {
       my $self = shift;
@@ -115,7 +115,7 @@
 specific.
 
 In most cases, Perl's built-in garbage collection is sufficient, and
-you won't need ot provide a C<DEMOLISH> method.
+you won't need to provide a C<DEMOLISH> method.
 
 =head1 AUTHOR
 




More information about the Moose-commits mailing list