Document new roles, types and utility functions

[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Role / BuildArgs.pm

diff --git a/lib/SQL/Translator/Role/BuildArgs.pm b/lib/SQL/Translator/Role/BuildArgs.pm
index bf5a375..4212f2b 100644 (file)
--- a/lib/SQL/Translator/Role/BuildArgs.pm
+++ b/lib/SQL/Translator/Role/BuildArgs.pm
@@ -1,4 +1,23 @@
 package SQL::Translator::Role::BuildArgs;
+
+=head1 NAME
+
+SQL::Translator::Role::BuildArgs - Remove undefined constructor arguments
+
+=head1 SYNOPSIS
+
+    package Foo;
+    use Moo;
+    with qw(SQL::Translator::Role::BuildArgs);
+
+=head1 DESCRIPTION
+
+This L<Moo::Role> wraps BUILDARGS to remove C<undef> constructor
+arguments for backwards compatibility with the old L<Class::Base>-based
+L<SQL::Translator::Schema::Object>.
+
+=cut
+
 use Moo::Role;
 
 around BUILDARGS => sub {