From: Arthur Axel 'fREW' Schmidt <frioux@gmail.com>
Date: Sat, 3 Apr 2010 08:04:07 +0000 (-0500)
Subject: Add description of Version set and start linking to it
X-Git-Tag: v0.001000_01~11
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=f1d1462a0fd0e01304443c9fc3b6023ad47f1ab4;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

Add description of Version set and start linking to it
---

diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm b/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm
index c8d4e79..77895d5 100644
--- a/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm
@@ -14,14 +14,7 @@ __END__
 =head1 DESCRIPTION
 
 Typically a VersionHandler will take a C<to_version> and yeild an iterator of
-"version sets."
-
-A "version set" could be defined as:
-
- subtype 'Version', as 'Str';
- subtype 'VersionSet', as 'ArrayRef[Str]';
-
-and all a "version set" does is uniquely identify a migration.
+L<version sets|/VERSION SET>.
 
 Typically a call to a VersionHandler's L</next_version_set> with a C<db_version>
 of 1 and a C<to_version> of 5 will iterate over something like the following:
@@ -37,8 +30,8 @@ or maybe just
  [1, 5]
  undef
 
-Really how the version sets are arranged is up to the VersionHandler being
-used.
+Really how the L<version sets|/VERSION SET> are arranged is up to the
+VersionHandler being used.
 
 In some cases users will not want versions to have inherent "previous
 versions," which is why the version set is an C<ArrayRef>.  In those cases the
@@ -67,8 +60,8 @@ there is no inherent order for this type of database upgraded.
 
 =head2 Downgrades
 
-For the typical case I'd like downgrades to be easy for users to perform and
-understand.  That means that with the first two examples give above we can use
+For the typical case downgrades should be easy for users to perform and
+understand.  That means that with the first two examples given above we can use
 the L</previous_version_set> iterator to yeild the following:
 
 
@@ -96,7 +89,7 @@ describes a version change, and not necesarily a defined progression.
  }
  print qq(\n);
 
-return an arrayref describing each version that needs to be
+Return a L<version set|/VERSION SET> describing each version that needs to be
 installed to upgrade to C<< $dh->to_version >>.
 
 =method previous_version_set
@@ -107,9 +100,18 @@ installed to upgrade to C<< $dh->to_version >>.
  }
  print qq(\n);
 
-return an arrayref describing each version that needs to be
+Return a L<version set|/VERSION SET> describing each version that needs to be
 "installed" to downgrade to C<< $dh->to_version >>.
 
+=head1 VERSION SET
+
+A version set could be defined as:
+
+ subtype 'Version', as 'Str';
+ subtype 'VersionSet', as 'ArrayRef[Str]';
+
+A version set should uniquely identify a migration.
+
 =head1 KNOWN IMPLEMENTATIONS
 
 =over