Documentation Fixes

[prev] [thread] [next] [Date index for 2004/10/25]

--5vNYLRcllDrimb99
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

The attached patch contains several fixes to the documentation.

Tom

--5vNYLRcllDrimb99
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="class-dbi-doc.patch"

--- DBI.pm.orig	Thu Sep 23 10:22:13 2004
+++ DBI.pm	Tue Oct 19 16:43:17 2004
@@ -1259,7 +1259,7 @@
 
 =head1 NAME
 
-	Class::DBI - Simple Database Abstraction
+Class::DBI - Simple Database Abstraction
 
 =head1 SYNOPSIS
 
@@ -1413,8 +1413,8 @@
 
 =item I<Done.>
 
-That's it! You now have a class with methods to L<\create>(),
-L<\retrieve>(), L<\search>() for, L<\update>() and L<\delete>() objects
+That's it! You now have a class with methods to L</create>(),
+L</retrieve>(), L</search>() for, L</update>() and L</delete>() objects
 from your table, as well as accessors and mutators for each of the
 columns in that object (row).
 
@@ -1508,7 +1508,7 @@
 
 	__PACKAGE__-->table('orders', 'orders');
 
-As with table, this is inherited but can be overriden.
+As with table, this is inherited but can be overridden.
 
 =head2 sequence / auto_increment
 
@@ -1738,7 +1738,7 @@
 automatically.  Or a single parameter can be supplied and will be
 used as the new key.
 
-For tables with a multi-olumn primary key, copy() must be called with
+For tables with a multi-column primary key, copy() must be called with
 parameters which supply new values for all primary key columns, unless
 a C<before_create> trigger will supply them. The create() method will
 fail if any primary key columns are not defined.
@@ -1932,7 +1932,7 @@
 For exceptions that are caught and propagated by Class::DBI, $message
 includes the text of $@ and the original $@ value is available in $info{err}.
 That allows you to correctly propagate exception objects that may have
-been thrown 'below' Class::DBI (using Exception::Class::DBI for example). 
+been thrown 'below' Class::DBI (using L<Exception::Class::DBI> for example). 
 
 Exceptions generated by some methods may provide additional data in
 $info{data} and, if so, also store the method name in $info{method}.
@@ -2047,7 +2047,7 @@
 unsaved changes.  Autoupdating can be more convenient for the programmer.
 Autoupdating is I<off> by default.
 
-If changes are left un-updated or not rolledback when the object is
+If changes are not updated or rolled back when the object is
 destroyed (falls out of scope or the program ends) then Class::DBI's
 DESTROY method will print a warning about unsaved changes.
 
@@ -2160,7 +2160,7 @@
 routines, you'll want to manipulate data in a Class::DBI object without
 using the usual get() and set() accessors, which may themselves call
 triggers, fetch information from the database, and the like. Rather than
-intereacting directly with the hash that makes up a Class::DBI object
+interacting directly with the hash that makes up a Class::DBI object
 (the exact implementation of which may change in a future release) you
 should use Class::DBI's low-level accessors. These appear 'private' to
 make you think carefully about using them - they should not be a common
@@ -2271,13 +2271,13 @@
 However, with overloaded stringification, the original code continues
 to work as before, with no code changes needed.
 
-This makes it much simpler and safer to add relationships to exisiting
+This makes it much simpler and safer to add relationships to existing
 applications, or remove them later.
 
 =head1 TABLE RELATIONSHIPS
 
 Databases are all about relationships. And thus Class::DBI provides a
-way for you to set up descriptions of your relationhips.
+way for you to set up descriptions of your relationships.
 
 Currently we provide three such methods: 'has_a', 'has_many', and
 'might_have'.
@@ -2537,6 +2537,7 @@
 	__PACKAGE__->add_constructor(method_name => 'SQL_where_clause');
 
 The SQL can be of arbitrary complexity and will be turned into:
+
 	SELECT (essential columns)
 	  FROM (table name)
 	 WHERE <your SQL>
@@ -2658,7 +2659,7 @@
 Selects which only return a single value can take advantage of Ima::DBI's
 $sth->select_val() call, coupled with Class::DBI's sql_single SQL.
 
-head3 select_val
+=head3 select_val
 
 Selects which only return a single value can take advantage of Ima::DBI's
 $sth->select_val() call. For example,
@@ -2888,7 +2889,7 @@
 out of scope. This means that over time the index will grow in memory.
 This is really only an issue for long-running environments like mod_perl,
 but every so often we go through and clean out dead references to prevent
-it. By default, this happens evey 1000 object loads, but you can change
+it. By default, this happens every 1000 object loads, but you can change
 that default for your class by calling the purge_object_index_every
 method with a number.
 
@@ -2933,7 +2934,7 @@
 
 Theoretically Class::DBI should work with almost any standard RDBMS. Of
 course, in the real world, we know that that's not true. We know that
-it works with MySQL, PostgrSQL, Oracle and SQLite, each of which have
+it works with MySQL, PostgreSQL, Oracle and SQLite, each of which have
 their own additional subclass on CPAN that you should explore if you're
 using them.
 
@@ -2975,7 +2976,7 @@
 general queries on the use of Class::DBI, bug reports, patches, and
 suggestions for improvements or new features.
 
-To join the list visit http://groups.kasei.com/mail/info/cdbi-talk
+To join the list visit L<http://groups.kasei.com/mail/info/cdbi-talk>;.
 
 You can also report bugs through the CPAN RT interface, but I'll
 proabably also forward those to the mailing list for discussion (and
@@ -3000,18 +3001,18 @@
 =head1 SEE ALSO
 
 There is a Class::DBI wiki at:
-	http://www.class-dbi.com/cgi-bin/wiki/index.cgi?HomePage
+L<http://www.class-dbi.com/cgi-bin/wiki/index.cgi?HomePage>;
 
 Amongst other things it provides the beginnings of a Cookbook of typical
 tricks and tips. Please contribute!
 
 There are lots of 3rd party subclasses and plugins available.
 For a full list see:
-	http://search.cpan.org/search?query=Class%3A%3ADBI&mode=module
+	L<http://search.cpan.org/search?query=Class%3A%3ADBI&mode=module>;
 
 An article on Class::DBI was published on Perl.com a while ago. It's
 slightly out of date already, but it's a good introduction:
-	http://www.perl.com/pub/a/2002/11/27/classdbi.html
+	L<http://www.perl.com/pub/a/2002/11/27/classdbi.html>;
 
 http://poop.sourceforge.net/ provides a document comparing a variety
 of different approaches to database persistence, such as Class::DBI,

--5vNYLRcllDrimb99--