From: Yuval Kogman <nothingmuch@woobling.org>
Date: Sat, 26 Nov 2005 03:31:27 +0000 (+0000)
Subject: Doc update for latest TypeKey goodness
X-Git-Tag: v0.03~16
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Authentication-Credential-HTTP-Proxy.git;a=commitdiff_plain;h=97676d77bae8c376a2189468209e29735656cda6

Doc update for latest TypeKey goodness
---

diff --git a/lib/Catalyst/Plugin/Authentication/Credential/TypeKey.pm b/lib/Catalyst/Plugin/Authentication/Credential/TypeKey.pm
index cec5b63..4e6ecd2 100644
--- a/lib/Catalyst/Plugin/Authentication/Credential/TypeKey.pm
+++ b/lib/Catalyst/Plugin/Authentication/Credential/TypeKey.pm
@@ -198,10 +198,14 @@ Where C<$parameters> is a the hash reference passed to
 L<Authen::TypeKey/verify>, and C<$result_of_verify> is the value returned by
 L<Authen::TypeKey/verify>.
 
+If this is unset, L<Catalyst::Plugin::Authentication/default_auth_store> will
+be used instead.
+
 =item user_class
 
-If C<auth_store> is not set it will use this class to instantiate an object,
-calling C<new> on the class with the same C<$parameters> hash ref.
+If C<auth_store> or the default store returns nothing from get_user, this class
+will be used to instantiate an object by calling C<new> on the class with the
+return value from L<Authen::TypeKey/verify>.
 
 =back