Minor documentation fixes; typos, POD formatting code syntax, return value explanatio...

[dbsrgits/SQL-Abstract.git] / lib / SQL / Abstract.pm

diff --git a/lib/SQL/Abstract.pm b/lib/SQL/Abstract.pm
index 61d4762..4279a9b 100644 (file)
--- a/lib/SQL/Abstract.pm
+++ b/lib/SQL/Abstract.pm
@@ -497,9 +497,15 @@ sub _recurse_where {
 
   my ($sql, @bind) =  $self->$method($where, $logic);
 
-  # DBIx::Class directly calls _recurse_where in scalar context, so
-  # we must implement it, even if not in the official API
-  return wantarray ? ($sql, @bind) : $sql;
+  # DBIx::Class used to call _recurse_where in scalar context
+  # something else might too...
+  if (wantarray) {
+    return ($sql, @bind);
+  }
+  else {
+    belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
+    return $sql;
+  }
 }
 
 
@@ -1772,9 +1778,9 @@ Easy, eh?
 
 =head1 METHODS
 
-The methods are simple. There's one for each major SQL operation,
+The methods are simple. There's one for every major SQL operation,
 and a constructor you use first. The arguments are specified in a
-similar order to each method (table, then fields, then a where
+similar order for each method (table, then fields, then a where
 clause) to try and simplify things.
 
 =head2 new(option => 'value')
@@ -2190,7 +2196,7 @@ or perhaps even
 
 If you fall victim to the above - please attempt to reduce the problem
 to something that could be sent to the L<SQL::Abstract developers
-|DBIx::Class/GETTING_HELP/SUPPORT>
+|DBIx::Class/GETTING HELP/SUPPORT>
 (either publicly or privately). As a workaround in the meantime you can
 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
 value, which will most likely eliminate your problem (at the expense of
@@ -2344,7 +2350,7 @@ Which would generate:
     @bind = ('2', '5', 'nwiger');
 
 If you want to include literal SQL (with or without bind values), just use a
-scalar reference or array reference as the value:
+scalar reference or reference to an arrayref as the value:
 
     my %where  = (
         date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
@@ -2353,7 +2359,7 @@ scalar reference or array reference as the value:
 
 Which would generate:
 
-    $stmt = "WHERE date_entered > "to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
+    $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
     @bind = ('11/26/2008');
 
 
@@ -2367,7 +2373,7 @@ this (notice the C<AND>):
 
 Because, in Perl you I<can't> do this:
 
-    priority => { '!=', 2, '!=', 1 }
+    priority => { '!=' => 2, '!=' => 1 }
 
 As the second C<!=> key will obliterate the first. The solution
 is to use the special C<-modifier> form inside an arrayref:
@@ -2559,10 +2565,10 @@ to change the logic inside :
 
 That would yield:
 
-    WHERE ( user = ? AND (
-               ( workhrs > ? AND geo = ? )
-            OR ( workhrs < ? OR geo = ? )
-          ) )
+    $stmt = "WHERE ( user = ?
+               AND ( ( workhrs > ? AND geo = ? )
+                  OR ( workhrs < ? OR geo = ? ) ) )";
+    @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
 
 =head3 Algebraic inconsistency, for historical reasons
 
@@ -2692,12 +2698,13 @@ This would create:
     @bind = ('10');
 
 Note that you must pass the bind values in the same format as they are returned
-by L</where>. That means that if you set L</bindtype> to C<columns>, you must
-provide the bind values in the C<< [ column_meta => value ] >> format, where
-C<column_meta> is an opaque scalar value; most commonly the column name, but
-you can use any scalar value (including references and blessed references),
-L<SQL::Abstract> will simply pass it through intact. So if C<bindtype> is set
-to C<columns> the above example will look like:
+by L<where|/where(\%where, \@order)>. This means that if you set L</bindtype>
+to C<columns>, you must provide the bind values in the
+C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
+scalar value; most commonly the column name, but you can use any scalar value
+(including references and blessed references), L<SQL::Abstract> will simply
+pass it through intact. So if C<bindtype> is set to C<columns> the above
+example will look like:
 
     my %where = (
        date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
@@ -2907,14 +2914,14 @@ Either a coderef or a plain scalar method name. In both cases
 the expected return is C<< ($sql, @bind) >>.
 
 When supplied with a method name, it is simply called on the
-L<SQL::Abstract/> object as:
+L<SQL::Abstract> object as:
 
  $self->$method_name ($field, $op, $arg)
 
  Where:
 
-  $op is the part that matched the handler regex
   $field is the LHS of the operator
+  $op is the part that matched the handler regex
   $arg is the RHS
 
 When supplied with a coderef, it is called as:
@@ -2983,7 +2990,7 @@ Either a coderef or a plain scalar method name. In both cases
 the expected return is C<< $sql >>.
 
 When supplied with a method name, it is simply called on the
-L<SQL::Abstract/> object as:
+L<SQL::Abstract> object as:
 
  $self->$method_name ($op, $arg)