From: Robert Sedlacek <r.sedlacek@shadowcat.co.uk>
Date: Thu, 1 Oct 2015 17:12:28 +0000 (+0000)
Subject: documentation fixes, stability warning, relationship type notice
X-Git-Tag: v0.000001~3
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=5d049dcbc7c377a5bd3375ef2cf0dde44126ae94;p=dbsrgits%2FDBIx-Class-ParameterizedJoinHack.git

documentation fixes, stability warning, relationship type notice
---

diff --git a/lib/DBIx/Class/ParameterizedJoinHack.pm b/lib/DBIx/Class/ParameterizedJoinHack.pm
index b332c89..d6fb4b2 100644
--- a/lib/DBIx/Class/ParameterizedJoinHack.pm
+++ b/lib/DBIx/Class/ParameterizedJoinHack.pm
@@ -157,6 +157,10 @@ DBIx::Class::ParameterizedJoinHack - Parameterized Relationship Joins
         )
         ->all;
 
+=head1 WARNING
+
+This module uses L<DBIx::Class> internals and may break at any time.
+
 =head1 DESCRIPTION
 
 This L<DBIx::Class> component allows to declare dynamically parameterized
@@ -166,10 +170,14 @@ Add the component to your Result class as usual:
 
     __PACKAGE__->load_components(qw( ParameterizedJoinHack ));
 
-See L<parameterized_has_many> for details on declaring relations.
+See L</parameterized_has_many> for details on declaring relations.
 
 See L<DBIx::Class::ResultSet::ParameterizedJoinHack> for ResultSet usage.
 
+B<Note:> Currently only L</parameterized_has_many> is implemented, since
+it is the most requested use-case. However, adding support for other
+relationship types is possible if a use-case is found.
+
 =head1 METHODS
 
 =head2 parameterized_has_many