various small doc fixes

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Schema.pm

diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm
index 4f3a545..e0cb8cc 100644 (file)
--- a/lib/DBIx/Class/Schema.pm
+++ b/lib/DBIx/Class/Schema.pm
@@ -50,7 +50,7 @@ use L<DBIx::Class> and allows you to use more than one concurrent connection
 with your classes.
 
 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
-carefully as DBIx::Class does things a little differently. Note in
+carefully, as DBIx::Class does things a little differently. Note in
 particular which module inherits off which.
 
 =head1 METHODS
@@ -59,12 +59,12 @@ particular which module inherits off which.
 
 =over 4
 
-=item Arguments: ($moniker, $component_class)
+=item Arguments: $moniker, $component_class
 
 =back
 
 Registers a class which isa L<DBIx::Class::ResultSourceProxy>. Equivalent to
-calling
+calling:
 
   $schema->register_source($moniker, $component_class->result_source_instance);
 
@@ -79,7 +79,7 @@ sub register_class {
 
 =over 4
 
-=item Arguments: ($moniker, $result_source)
+=item Arguments: $moniker, $result_source
 
 =back
 
@@ -105,15 +105,13 @@ sub register_source {
 
 =over 4
 
-=item Arguments: ($moniker)
+=item Arguments: $moniker
 
 =item Return Value: $classname
 
 =back
 
-Retrieves the result class name for the given moniker.
-
-e.g.,
+Retrieves the result class name for the given moniker. For example:
 
   my $class = $schema->class('CD');
 
@@ -128,7 +126,7 @@ sub class {
 
 =over 4
 
-=item Arguments: ($moniker)
+=item Arguments: $moniker
 
 =item Return Value: $result_source
 
@@ -161,8 +159,7 @@ sub source {
 =back
 
 Returns the source monikers of all source registrations on this schema.
-
-e.g.,
+For example:
 
   my @source_monikers = $schema->sources;
 
@@ -174,7 +171,7 @@ sub sources { return keys %{shift->source_registrations}; }
 
 =over 4
 
-=item Arguments: ($moniker)
+=item Arguments: $moniker
 
 =item Return Value: $result_set
 
@@ -203,11 +200,11 @@ With no arguments, this method uses L<Module::Find> to find all classes under
 the schema's namespace. Otherwise, this method loads the classes you specify
 (using L<use>), and registers them (using L</"register_class">).
 
-It is possible to comment out classes with a leading '#', but note that perl
-will think it's a mistake (trying to use a comment in a qw list) so you'll
-need to add "no warnings 'qw';" before your load_classes call.
+It is possible to comment out classes with a leading C<#>, but note that perl
+will think it's a mistake (trying to use a comment in a qw list), so you'll
+need to add C<no warnings 'qw';> before your load_classes call.
 
-e.g.,
+Example:
 
   My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
                              # etc. (anything under the My::Schema namespace)
@@ -286,16 +283,16 @@ sub load_classes {
 
 =over 4
 
-=item Arguments: ($target_namespace, @db_info)
+=item Arguments: $target_namespace, @db_info
 
 =item Return Value: $new_schema
 
 =back
 
-Calls L<DBIx::Class::schema/"compose_namespace"> to the target namespace,
-calls L<DBIx::Class::Schema/connection>(@db_info) on the new schema, then
-injects the L<DBix::Class::ResultSetProxy> component and a resultset_instance
-classdata entry on all the new classes in order to support
+Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
+calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
+then injects the L<DBix::Class::ResultSetProxy> component and a
+resultset_instance classdata entry on all the new classes, in order to support
 $target_namespaces::$class->search(...) method calls.
 
 This is primarily useful when you have a specific need for class method access
@@ -365,13 +362,13 @@ new $schema object. If C<$additional_base_class> is given, the new composed
 classes will inherit from first the corresponding classe from the current
 schema then the base class.
 
-e.g. (for a schema with My::Schema::CD and My::Schema::Artist classes),
+For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
 
   $schema->compose_namespace('My::DB', 'Base::Class');
   print join (', ', @My::DB::CD::ISA) . "\n";
   print join (', ', @My::DB::Artist::ISA) ."\n";
 
-Will produce the output
+will produce the output
 
   My::Schema::CD, Base::Class
   My::Schema::Artist, Base::Class
@@ -411,7 +408,7 @@ sub compose_namespace {
 
 =over 4
 
-=item Arguments: ($target, @info)
+=item Arguments: $target, @info
 
 =back
 
@@ -431,7 +428,7 @@ sub setup_connection_class {
 
 =over 4
 
-=item Arguments: (@args)
+=item Arguments: @args
 
 =item Return Value: $new_schema
 
@@ -464,7 +461,7 @@ sub connection {
 
 =over 4
 
-=item Arguments: (@info)
+=item Arguments: @info
 
 =item Return Value: $new_schema
 
@@ -512,7 +509,7 @@ sub txn_rollback { shift->storage->txn_rollback }
 
 =over 4
 
-=item Arguments: (C<$coderef>, @coderef_args?)
+=item Arguments: C<$coderef>, @coderef_args?
 
 =item Return Value: The return value of $coderef
 
@@ -643,7 +640,7 @@ sub clone {
 
 =over 4
 
-=item Arguments: ($moniker, \@data);
+=item Arguments: $moniker, \@data;
 
 =back
 
@@ -679,7 +676,7 @@ sub populate {
 
 =over 4 
 
-=item Arguments: ($message)
+=item Arguments: $message
 
 =back
 
@@ -697,7 +694,7 @@ sub throw_exception {
 
 =over 4
 
-=item Arguments: ($sqlt_args)
+=item Arguments: $sqlt_args
 
 =back