document various delegation roles by linking to original classes

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

diff --git a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
index 99912cd..edc18ab 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::Deprecated::WithDeprecatedSqltDeployMethod;
 use Moose::Role;
 
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated;
 
 has deploy_method => (
@@ -24,7 +26,7 @@ has databases => (
   default => sub { [qw( MySQL SQLite PostgreSQL )] },
 );
 
-has sqltargs => (
+has sql_translator_args => (
   isa => 'HashRef',
   is  => 'ro',
   default => sub { {} },
@@ -33,15 +35,21 @@ has sqltargs => (
 sub _build_deploy_method {
   my $self = shift;
   DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated->new({
-    schema            => $self->schema,
-    databases         => $self->databases,
-    upgrade_directory => $self->upgrade_directory,
-    sqltargs          => $self->sqltargs,
+    schema              => $self->schema,
+    databases           => $self->databases,
+    upgrade_directory   => $self->upgrade_directory,
+    sql_translator_args => $self->sql_translator_args,
   });
 }
 
 1;
 
+# vim: ts=2 sw=2 expandtab
+
 __END__
 
-vim: ts=2 sw=2 expandtab
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated>