document various delegation roles by linking to original classes

[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / WithReasonableDefaults.pm

diff --git a/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm b/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
index 8a36cf0..2f1c913 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithReasonableDefaults;
 use Moose::Role;
 
+# ABSTRACT: Make default arguments to a few methods sensible
+
 requires qw( prepare_upgrade prepare_downgrade database_version schema_version );
 
 around prepare_upgrade => sub {
@@ -40,3 +42,32 @@ around install_resultsource => sub {
 __END__
 
 vim: ts=2 sw=2 expandtab
+
+=head1 CONVENIENCE
+
+The whole point of this role is to set defaults for arguments of various
+methods.  It's a little awesome.
+
+=head1 METHODS
+
+=head2 prepare_upgrade
+
+Defaulted args:
+
+  my $from_version = $self->database_version;
+  my $to_version   = $self->schema_version;
+  my $version_set  = [$from_version, $to_version];
+
+=head2 prepare_downgrade
+
+Defaulted args:
+
+  my $from_version = $self->database_version;
+  my $to_version   = $self->schema_version;
+  my $version_set  = [$from_version, $to_version];
+
+=head2 install_resultsource
+
+Defaulted args:
+
+  my $version = $self->to_version;