From: K J Cheetham <jamie@shadowcatsystems.co.uk>
Date: Thu, 24 Aug 2006 13:29:20 +0000 (+0000)
Subject: Documentation fixes.
X-Git-Tag: v0.07002~23
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=d3b0e369ff75261ae5f806997a56650bc6c216c5;p=dbsrgits%2FDBIx-Class.git

Documentation fixes.
---

diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm
index 8bc4089..207c873 100644
--- a/lib/DBIx/Class.pm
+++ b/lib/DBIx/Class.pm
@@ -184,61 +184,62 @@ blblack: Brandon L. Black <blblack@gmail.com>
 
 bluefeet: Aran Deltac <bluefeet@cpan.org>
 
-LTJake: Brian Cassidy <bricas@cpan.org>
+captainL: Luke Saunders <luke.saunders@gmail.com>
+
+castaway: Jess Robinson
 
 claco: Christopher H. Laco
 
 clkao: CL Kao
 
-typester: Daisuke Murase <typester@cpan.org>
-
 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
 
-Numa: Dan Sully <daniel@cpan.org>
+draven: Marcus Ramberg <mramberg@cpan.org>
 
 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
 
-ningu: David Kamholz <dkamholz@cpan.org>
-
-jesper: Jesper Krogh
+dyfrgi: Michael Leuchtenmurg <michael@slashhome.org>
 
-castaway: Jess Robinson
+gphat: Cory G Watson <gphat@cpan.org>
 
-quicksilver: Jules Bean
+jesper: Jesper Krogh
 
 jguenther: Justin Guenther <jguenther@cpan.org>
 
-captainL: Luke Saunders <luke.saunders@gmail.com>
+konobi: Scott McWhirter
 
-draven: Marcus Ramberg <mramberg@cpan.org>
+LTJake: Brian Cassidy <bricas@cpan.org>
 
 nigel: Nigel Metheringham <nigelm@cpan.org>
 
+ningu: David Kamholz <dkamholz@cpan.org>
+
+Numa: Dan Sully <daniel@cpan.org>
+
 paulm: Paul Makepeace
 
+penguin: K J Cheetham
+
 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
 
-sc_: Just Another Perl Hacker
+quicksilver: Jules Bean
 
-konobi: Scott McWhirter
+sc_: Just Another Perl Hacker
 
 scotty: Scotty Allen <scotty@scottyallen.com>
 
 sszabo: Stephan Szabo <sszabo@bigpanda.com>
 
-zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
-
 Todd Lipcon
 
-wdh: Will Hawes
+typester: Daisuke Murase <typester@cpan.org>
 
-gphat: Cory G Watson <gphat@cpan.org>
+wdh: Will Hawes
 
-dyfrgi: Michael Leuchtenmurg <michael@slashhome.org>
+zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
 
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-
diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm
index e03ab16..60250b6 100644
--- a/lib/DBIx/Class/Row.pm
+++ b/lib/DBIx/Class/Row.pm
@@ -99,7 +99,8 @@ sub in_storage {
   $obj->update;
 
 Must be run on an object that is already in the database; issues an SQL
-UPDATE query to commit any changes to the object to the db if required.
+UPDATE query to commit any changes to the object to the database if
+required.
 
 =cut
 
@@ -476,4 +477,3 @@ Matt S. Trout <mst@shadowcatsystems.co.uk>
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-
diff --git a/lib/DBIx/Class/Storage/DBI.pm b/lib/DBIx/Class/Storage/DBI.pm
index eb15d8a..71c14aa 100644
--- a/lib/DBIx/Class/Storage/DBI.pm
+++ b/lib/DBIx/Class/Storage/DBI.pm
@@ -828,6 +828,12 @@ sub _select {
 
 =head2 select
 
+=over 4
+
+=item Arguments: $ident, $select, $condition, $attrs
+
+=back
+
 Handle a SQL select statement.
 
 =cut
@@ -857,6 +863,12 @@ sub select_single {
 
 =head2 sth
 
+=over 4
+
+=item Arguments: $sql
+
+=back
+
 Returns a L<DBI> sth (statement handle) for the supplied SQL.
 
 =cut
@@ -869,7 +881,7 @@ sub sth {
 
 =head2 columns_info_for
 
-Returns database type info for a given table columns.
+Returns database type info for a given table column.
 
 =cut
 
@@ -958,7 +970,7 @@ sub sqlt_type { shift->dbh->{Driver}->{Name} }
 
 =back
 
-Creates an SQL file based on the Schema, for each of the specified
+Creates a SQL file based on the Schema, for each of the specified
 database types, in the given directory.
 
 Note that this feature is currently EXPERIMENTAL and may not work correctly
@@ -1018,8 +1030,24 @@ sub create_ddl_dir
 
 =head2 deployment_statements
 
-Create the statements for L</deploy> and
-L<DBIx::Class::Schema/deploy>.
+=over 4
+
+=item Arguments: $schema, $type, $version, $directory, $sqlt_args
+
+=back
+
+Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
+The database driver name is given by C<$type>, though the value from
+L</sqlt_type> is used if it is not specified.
+
+C<$directory> is used to return statements from files in a previously created
+L</create_ddl_dir> directory and is optional. The filenames are constructed
+from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
+
+If no C<$directory> is specified then the statements are constructed on the
+fly using L<SQL::Translator> and C<$version> is ignored.
+
+See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
 
 =cut
 
@@ -1197,4 +1225,3 @@ Andy Grundman <andy@hybridized.org>
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-