| Subject: | Documentation issues |
I was trying to package the latest version of SQL::Abstract for Debian,
but I hit errors due to the issues with the pod documentation. I have
added extra documentation as indicated in the attached files. They might
not be adequate but I think they will do until something better is written.
| Subject: | pod.patch |
Author: Nicholas Bamber <nicholas@periapt.co.uk>
Forwarded: no
Last-Update: 2010-10-30
Subject: Bad header in pod format
--- a/lib/DBIx/Class/Storage/Debug/PrettyPrint.pm
+++ b/lib/DBIx/Class/Storage/Debug/PrettyPrint.pm
@@ -54,6 +54,10 @@
=pod
+=head1 NAME
+
+DBIx::Class::Storage::Debug::PrettyPrint - Helper module for SQL::Abstract
+
=head1 SYNOPSIS
package MyApp::Schema;
--- a/lib/SQL/Abstract/Tree.pm
+++ b/lib/SQL/Abstract/Tree.pm
@@ -481,6 +481,10 @@
=pod
+=head1 NAME
+
+SQL::Abstract::Tree - Help module for SQL::Abstract
+
=head1 SYNOPSIS
my $sqla_tree = SQL::Abstract::Tree->new({ profile => 'console' });
| Subject: | format-sql.pod |
=head1 NAME
format-sql - utility to format SQL statements
=head1 SYNOPSIS
format-sql [--profile|-p I<none>|I<console>|I<console_monochrome>|I<html>]
format-sql --usage
=head1 SUMMARY
This program creates an interactive environment, where the user types
in SQL, and the program responds with the SQL neatly formatted, revealing
the underlying syntactical structure.
=head1 OPTIONS
The C<-p> or C<--profile> can select between four alternative ways of formatting
the data, known as profiles. This defaults to I<console>.