From: Robert Sedlacek <r.sedlacek@shadowcat.co.uk>
Date: Wed, 26 Aug 2015 17:16:25 +0000 (+0000)
Subject: documentation
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=af26217a35321f06beadd550f188d855198b690f;p=dbsrgits%2FDBIx-Class-RowCountStatistics.git

documentation
---

diff --git a/lib/CtrlO/DBIC/Cursor/RowCountStatistics.pm b/lib/CtrlO/DBIC/Cursor/RowCountStatistics.pm
index 1e3221d..a236981 100644
--- a/lib/CtrlO/DBIC/Cursor/RowCountStatistics.pm
+++ b/lib/CtrlO/DBIC/Cursor/RowCountStatistics.pm
@@ -55,26 +55,44 @@ sub _emit_query_complete {
 
 =head1 NAME
 
-CtrlO::DBIC::Cursor::RowCountStatistics - Description goes here
+CtrlO::DBIC::Cursor::RowCountStatistics - Provide row-count statistics
 
 =head1 SYNOPSIS
 
+    my $schema = Schema->connect(
+        $dsn, $username, $password,
+        {},
+        { cursor_class => 'CtrlO::DBIC::Cursor::RowCountStatistics' },
+    );
+
 =head1 DESCRIPTION
 
+This L<DBIx::Class::Storage::DBI::Cursor> subclass allows you to log the
+number of rows that were fetched through the cursor.
+
+=head1 DEBUG OBJECT METHODS
+
+=head2 query_complete (optional)
+
+If available on the L<DBIx::Class::Storage/debugobj>, this method will be
+called with the following signature:
+
+    sub query_complete {
+        my ($self, $row_count, $sql, @bind_values) = @_;
+        ...
+    }
+
 =head1 AUTHOR
 
  r.sedlacek@shadowcat.co.uk
 
 =head1 CONTRIBUTORS
 
-None yet - maybe this software is perfect! (ahahahahahahahahaha)
+None yet.
 
 =head1 COPYRIGHT
 
 Copyright (c) 2015 the CtrlO::DBIC::Cursor::RowCountStatistics L</AUTHOR> and L</CONTRIBUTORS>
 as listed above.
 
-=head1 LICENSE
-
-This library is free software and may be distributed under the same terms
-as perl itself.
+=cut