some documentation improvements, some test fixes

[maypole.git] / lib / Maypole.pm

diff --git a/lib/Maypole.pm b/lib/Maypole.pm
index 3fcfd159a835442d78ec806fdb1c948765e25efd..fe2d29a0c5dad032b905a55aade0945b1faffd3d 100644 (file)
--- a/lib/Maypole.pm
+++ b/lib/Maypole.pm
@@ -253,7 +253,7 @@ Some packages respond to higher debug levels, try increasing it to 2 or 3.
 
 =cut
 
-sub debug { 0 }      
+sub debug { 0 }
 
 =item config
 
@@ -261,20 +261,34 @@ Returns the L<Maypole::Config> object
 
 =item setup
 
-    My::App->setup($data_source, $user, $password, \%attr);
-
-Initialise the Maypole application and plugins and model classes - see
-L<Maypole::Manual::Plugins>.
-
-If your model is based on L<Maypole::Model::CDBI>, the C<\%attr> hashref can 
-contain options that are passed directly to L<Class::DBI::Loader>, to control 
-how the model hierarchy is constructed. 
+   My::App->setup($data_source, $user, $password, \%attr);
 
+Initialise the Maypole application and plugins and model classes.
 Your application should call this B<after> setting up configuration data via
 L<"config">.
 
+It calls the hook  C<setup_model> to setup the model. The %attr hash contains
+options and arguments used to set up the model. See the particular model's
+documentation. However here is the most usage of setup where
+Maypole::Model::CDBI is the base class.
+
+ My::App->setup($data_source, $user, $password,
+       {  opitons => {  # These are DB connection options
+               AutoCommit => 0,
+               RaiseError => 1,
+               ...
+          },
+          # These are Class::DBI::Loader arguments.
+          relationships  => 1,
+          ...
+       }
+ );
+
+Also, see  L<Maypole::Manual::Plugins>.
+
 =cut
 
+
 sub setup
 {
     my $class = shift;